documenting-code

name	Documenting Code
description	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.

Documenting Code

Standards Reference

All documentation follows init-project conventions:

• IDs: F-## (features), US-### (user stories) - unique and traceable across docs
• Files: docs/feature-specs/F-##-slug.yaml, docs/user-stories/US-###-slug.yaml
• Front-matter: Required title, status, last_updated fields
• Traceability: Every F-## links to PRD, every US-### links to F-##

Reference /file-templates/init-project/CLAUDE.md for full conventions.

Documentation Inventory

Required docs (from init-project template):

• docs/product-requirements.yaml - Project goals, scope, features, success metrics
• docs/feature-specs/F-##-*.yaml - One per F-## feature
• docs/user-stories/US-###-*.yaml - One per user story
• docs/user-flows/*.yaml - Primary user flows
• docs/api-contracts.yaml - API endpoints
• docs/system-design.yaml - Architecture
• docs/data-plan.yaml - Metrics and data storage
• docs/design-spec.yaml - UI/UX specifications

Workflow

1. Check Current State

Before making changes, understand what exists: