Update Docs
Commands documentation 2,815
npx claude-code-templates@latest --command documentation/update-docs Content
Documentation Update & Synchronization
Update project documentation systematically: $ARGUMENTS
Current Documentation State
- Documentation structure: !
find . -name "*.md" | head -10 - Specs directory: @specs/ (if exists)
- Implementation status: !
grep -r "✅\|❌\|⚠️" docs/ specs/ 2>/dev/null | wc -lstatus indicators - Recent changes: !
git log --oneline --since="1 week ago" -- "*.md" | head -5 - Project progress: @CLAUDE.md or @README.md (if exists)
Task
Documentation Analysis
Review current documentation status:
- Check
specs/implementation_status.mdfor overall project status - Review implemented phase document (
specs/phase{N}_implementation_plan.md) - Review
specs/flutter_structurizr_implementation_spec.mdandspecs/flutter_structurizr_implementation_spec_updated.md - Review
specs/testing_plan.mdto ensure it is current given recent test passes, failures, and changes - Examine
CLAUDE.mdandREADME.mdfor project-wide documentation - Check for and document any new lessons learned or best practices in CLAUDE.md
- Check
Analyze implementation and testing results:
- Review what was implemented in the last phase
- Review testing results and coverage
- Identify new best practices discovered during implementation
- Note any implementation challenges and solutions
- Cross-reference updated documentation with recent implementation and test results to ensure accuracy
Documentation Updates
Update phase implementation document:
- Mark completed tasks with ✅ status
- Update implementation percentages
- Add detailed notes on implementation approach
- Document any deviations from original plan with justification
- Add new sections if needed (lessons learned, best practices)
- Document specific implementation details for complex components
- Include a summary of any new troubleshooting tips or workflow improvements discovered during the phase
Update implementation status document:
- Update phase completion percentages
- Add or update implementation status for components
- Add notes on implementation approach and decisions
- Document best practices discovered during implementation
- Note any challenges overcome and solutions implemented
Update implementation specification documents:
- Mark completed items with ✅ or strikethrough but preserve original requirements
- Add notes on implementation details where appropriate
- Add references to implemented files and classes
- Update any implementation guidance based on experience
Update CLAUDE.md and README.md if necessary:
- Add new best practices
- Update project status
- Add new implementation guidance
- Document known issues or limitations
- Update usage examples to include new functionality
Document new testing procedures:
- Add details on test files created
- Include test running instructions
- Document test coverage
- Explain testing approach for complex components
Documentation Formatting and Structure
Maintain consistent documentation style:
- Use clear headings and sections
- Include code examples where helpful
- Use status indicators (✅, ⚠️, ❌) consistently
- Maintain proper Markdown formatting
Ensure documentation completeness:
- Cover all implemented features
- Include usage examples
- Document API changes or additions
- Include troubleshooting guidance for common issues
Guidelines
- DO NOT CREATE new specification files
- UPDATE existing files in the
specs/directory - Maintain consistent documentation style
- Include practical examples where appropriate
- Cross-reference related documentation sections
- Document best practices and lessons learned
- Provide clear status updates on project progress
- Update numerical completion percentages
- Ensure documentation reflects actual implementation
Provide a summary of documentation updates after completion, including:
- Files updated
- Major changes to documentation
- Updated completion percentages
- New best practices documented
- Status of the overall project after this phase