Documenting Code
Maintain project documentation synchronized with code. Keep feature specs, API contracts, and README current with init-project standards. Use when updating docs after code changes, adding new features, or ensuring documentation completeness.
Security Assessment
About Documenting Code
The 'Documenting Code' skill is designed to streamline and standardize the process of maintaining project documentation in sync with code changes. It ensures that the documentation—such as feature specifications, user stories, and API contracts—remains current and consistent with the evolving codebase. By following a structured documentation workflow, this skill minimizes the risk of outdated or incomplete documentation, ensuring that teams always have accurate and up-to-date information. This skill is particularly useful when working with large projects where frequent updates to code require corresponding changes in documentation, helping teams avoid the time-consuming task of manually tracking these updates.
FAQ
How do I update documentation for a new feature?
To update documentation for a new feature, create a new feature specification YAML file in `docs/feature-specs/` following the init-project template, add a corresponding entry in the product requirements document (PRD), and define any new API endpoints in `docs/api-contracts.yaml`. Additionally, ensure user stories are created in `docs/user-stories/` if necessary.
How can I verify if my documentation complies with the standards?
To verify documentation compliance, use the validation commands such as `/manage-project/validate/check-consistency` to ensure IDs are correctly linked and `/manage-project/validate/check-coverage` to check for orphaned documents. You can also run `./check-project.sh` for a full validation.
Is there a way to check for broken links in the documentation?
Yes, you can check for broken links by using the Bash utility `./check-project.sh`, which performs a comprehensive validation across all documentation files to identify and report broken links.
Can I use this skill for non-software projects?
While this skill is tailored for software development projects, the general principles of maintaining synchronized documentation can be adapted for other types of projects. However, some of the specific references (like API contracts) may not apply.
Install Documenting Code
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
CaptainCrouton89/.claude