documentation
Generate and update documentation from code. Use after successful implementation.
When & Why to Use This Skill
This Claude skill automates the creation and maintenance of comprehensive software documentation directly from source code. It streamlines the production of README files, API references, changelogs, and JSDoc comments, ensuring that technical documentation stays synchronized with the latest code implementations and follows industry best practices.
Use Cases
- Automated README Generation: Quickly generate professional project overviews, installation guides, and contribution rules for new or existing repositories.
- API Reference Synchronization: Automatically update endpoint descriptions, request/response formats, and error codes whenever the backend implementation changes.
- Changelog Maintenance: Systematically track version history, breaking changes, and migration steps to keep stakeholders informed of project progress.
- Codebase Standardization: Apply consistent JSDoc or docstring standards across the entire codebase to improve IDE intellisense and developer onboarding.
- Documentation Auditing: Use the built-in checklist to verify that all public APIs are documented and that code examples remain functional and accurate.
| name | documentation |
|---|---|
| description | Generate and update documentation from code. |
Documentation Skill
Purpose
Maintain accurate, helpful documentation.
Templates
README Template
Reference: templates/readme-template.md
API Documentation Template
Reference: templates/api-doc-template.md
Changelog Template
Reference: templates/changelog-template.md
JSDoc Standards
/**
* Brief description of what the function does.
*
* @param {string} name - Description of name parameter
* @param {Options} options - Description of options
* @returns {Result} Description of return value
* @throws {ValidationError} When validation fails
* @example
* const result = myFunction('test', { flag: true });
*/
function myFunction(name: string, options: Options): Result {
// ...
}
Documentation Types
README
- Project overview
- Installation instructions
- Quick start guide
- Configuration options
- Contributing guidelines
API Documentation
- Endpoint descriptions
- HTTP methods
- Request/response formats
- Authentication requirements
- Error codes
Code Documentation
- JSDoc/docstrings
- Inline comments (why, not what)
- Type annotations
- Example usage
Changelog
- Version history
- Breaking changes
- Migration steps
- Deprecation notices
Documentation Checklist
- README up to date
- API endpoints documented
- Code examples work
- Changelog updated
- JSDoc on public APIs
- Links are valid
- Spelling/grammar correct
Documentation Generation
Best Practices
Do
- Keep examples up to date
- Document breaking changes
- Use consistent formatting
- Include common use cases
- Explain the "why" not just "how"
Don't
- Document implementation details
- Let examples become stale
- Skip error scenarios
- Use jargon without explanation
- Assume reader knowledge
Storage Location
Save reports to: docs/reviews/documentation-{session}.md