Documenting Code

What problem does it solve?

This Skill ensures your project documentation remains synchronized with your codebase, maintaining feature specs, API contracts, and READMEs according to init-project standards. It solves the problem of outdated or incomplete documentation, ensuring that all team members have access to accurate and traceable information.

Core Features & Use Cases

• Standards Compliance: Adhere to init-project conventions for IDs (F-##, US-###), file paths, and required front-matter fields.
• Automated Updates: Guides you through updating documentation for feature changes, new features, and API modifications.
• Use Case: After implementing a new API endpoint, use this Skill to automatically update docs/api-contracts.yaml, the corresponding docs/feature-specs/F-##-*.yaml, and the docs/product-requirements.yaml. This ensures all documentation reflects the latest code, saving manual effort and preventing discrepancies.

Quick Start

Example: Update documentation after a feature change

1. Check state: "Read docs/product-requirements.yaml for feature list."

2. Update: "Update docs/feature-specs/F-123-user-profile.yaml with new fields."

3. Verify: "Check consistency using /manage-project/validate/check-consistency."