Documenting Code

The Documenting Code skill serves as the primary engine for maintaining high-integrity technical documentation within development environments. It enforces the 'init-project' standard, ensuring that every feature, user story, and architectural change is captured, linked, and validated against the codebase. By treating documentation as a first-class citizen of the development lifecycle, this skill prevents drift between implementation and intent, providing a clear audit trail for project growth.

• Automated traceability: Links user stories (US-###) to features (F-##) and PRD entries.

• Standardized documentation: Enforces consistent YAML structures for specs, system design, API contracts, and data plans.

• Integrated validation: Provides command-line utilities to check for broken links, orphaned documentation, and API alignment.

• README orchestration: Automatically updates project overviews, feature lists, and setup instructions based on current documentation state.

• Lifecycle management: Routes tasks through greenfield (initialization) or brownfield (update) workflows based on project maturity.

• Command suite: Includes direct utilities like /manage-project/update/update-feature and /manage-project/validate/check-consistency.

• Keep documentation current by running the orchestrator after every major implementation phase.

• Always verify standards compliance using the validation suite before finalizing a pull request or release.

• Use the provided bash scripts (e.g., check-project.sh) for full-system integrity checks.

• Ensure all API endpoints in api-contracts.yaml match the logic implemented in the source code.

• When adding new features, use the add-feature and add-api commands to ensure the correct file structure is generated automatically.

• Maintain front-matter metadata (title, status, last_updated) to enable accurate documentation tracking and stale-content detection.

• Utilize for: API documentation, system architecture updates, PRD maintenance, feature traceability, technical debt auditing, and README synchronization.