Overview
Documentation commands help automate the creation and maintenance of project documentation, ensuring consistency and completeness across your codebase.Documentation Generation
/create-docs
by jerseycheeseAnalyzes code structure and purpose to create comprehensive documentation detailing inputs/outputs, behavior, user interaction flows, and edge cases with error handling.
/docs
by slunsfordGenerates comprehensive documentation that follows project structure, documenting APIs and usage patterns with consistent formatting for better user understanding.
Documentation Maintenance
/update-docs
by ConsiliencyReviews current documentation status, updates implementation progress, reviews phase documents, and maintains documentation consistency across the project.
Changelog Management
/add-to-changelog
by berrydev-aiAdds new entries to changelog files while maintaining format consistency, properly documenting changes, and following established project standards for version tracking.
Issue Documentation
/explain-issue-fix
by hackdays-ioDocuments solution approaches for GitHub issues, explaining technical decisions, detailing challenges overcome, and providing implementation context for better understanding.
Documentation Benefits
Consistency
Automated documentation ensures consistent formatting and structure across your project.
Completeness
Commands analyze code to ensure all aspects are properly documented.
Time Savings
Automate repetitive documentation tasks to focus on development.
Better Onboarding
Comprehensive docs help new team members understand the codebase faster.
Documentation Workflow
A recommended workflow for documentation:- Initial Creation: Use
/create-docsor/docsfor new features or modules - Maintain Changelogs: Apply
/add-to-changelogafter significant changes - Update Existing: Run
/update-docsto refresh documentation after refactoring - Document Solutions: Use
/explain-issue-fixwhen resolving complex issues - Review & Refine: Regularly review generated documentation for accuracy
Best Practices
When using documentation commands:- Document Early: Create documentation alongside code, not as an afterthought
- Keep It Current: Update documentation whenever code changes
- Be Comprehensive: Document edge cases, error handling, and user flows
- Follow Standards: Maintain consistent formatting and structure
- Version Control: Track changelog entries with semantic versioning
- Link to Code: Include references to specific files and line numbers
Documentation Standards
Good documentation should include:- Purpose: What the code does and why it exists
- Usage: How to use the API or feature
- Parameters: Input types, constraints, and defaults
- Returns: Output types and possible values
- Examples: Common use cases and code samples
- Edge Cases: Error conditions and how they’re handled
- Dependencies: Required libraries or services