docs-validating-software-engineering-separation

Community

Validate docs only contain repo-specific engineering conventions

Authorwahidyankf
Version1.0.0
Installs0

System Documentation

What problem does it solve?

OSE-style monorepos often mix generic programming language tutorials (which belong in external official documentation) with repository-specific style guides in the docs/explanation/software-engineering/ directory, leading to duplicated, irrelevant content that wastes developer time and creates confusion about which rules apply to the specific codebase.

Core Features & Use Cases

  • Separation Rule Enforcement: Validates that all content under docs/explanation/software-engineering/programming-languages/ focuses exclusively on repository-specific conventions (naming standards, framework choices, architecture patterns) and contains no generic language syntax tutorials or duplicated official documentation.
  • Prerequisite Statement Checks: Ensures every programming language README includes a clear prerequisite knowledge section that links to official external learning resources and explicitly states the documentation is not a language tutorial.
  • Use Case: When bootstrapping a new OSE-style monorepo from the ose-primer template, use this skill to audit all language documentation to confirm it follows the required separation convention, eliminating redundant generic content.

Quick Start

Use this skill to audit all programming language documentation under docs/explanation/software-engineering/ to confirm it only contains repository-specific conventions and includes valid prerequisite links to external learning resources.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: docs-validating-software-engineering-separation
Download link: https://github.com/wahidyankf/ose-primer/archive/main.zip#docs-validating-software-engineering-separation

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.