doc-generator
Auto-generate documentation, comments, and API docs from code
When & Why to Use This Skill
The doc-generator skill automates the creation of comprehensive technical documentation, inline code comments, and API references directly from source code. It streamlines the documentation lifecycle for developers, ensuring codebases remain well-documented, readable, and maintainable with minimal manual effort.
Use Cases
- Automated API Reference: Extracting function signatures and logic to create structured API documentation for external or internal use.
- Legacy Code Documentation: Analyzing existing, undocumented codebases to generate explanatory comments and overview documents for better team onboarding.
- Standardized Commenting: Automatically adding JSDoc, Doxygen, or other standardized comment formats to source files to improve code quality and IDE intellisense.
- README Generation: Creating and updating project README files and technical guides based on the latest codebase changes to keep documentation in sync with development.
| name | doc-generator |
|---|---|
| description | Auto-generate documentation, comments, and API docs from code |
doc-generator
Overview
Auto-generate documentation, comments, and API docs from code
This skill was converted from a bash script to follow Anthropic's Agent Skills best practices.
Usage
doc-generator <command> [options]
Commands
TODO: Extract and document commands from the script
Run doc-generator --help to see available commands.
When to Use
TODO: Add specific use cases
Scripts
scripts/main.sh- Main functionality (converted from original doc-generator)
Claude can execute this script directly without loading it into context.
Additional Resources
For detailed information, see:
- reference/migration-notes.md - Conversion notes and TODOs
- reference/examples.md - Usage examples (TODO)
Progressive Disclosure
Consider adding these reference files:
reference/api-reference.md- Detailed command documentationreference/troubleshooting.md- Common issues and solutions