Automated Documentation Generator
Generates structured usage documentation, technical references, and command cheatsheets directly from project source files.
The Documentation Generator skill automates the tedious process of maintaining technical documentation by extracting metadata, commands, and logic directly from your codebase. It scans source files and skill definitions based on a configuration file to produce consistent, high-quality Markdown output including cheatsheets, full reference guides, and onboarding manuals. This ensures that your documentation remains perfectly synchronized with your actual code implementation, reducing the overhead of manual updates and improving developer experience.
Key Features
01Bilingual documentation support for English and Traditional Chinese
02Configurable source scanning via YAML-based project settings
03Automated extraction of command definitions and options from source code
04Streamlined workflow from source scanning to final Markdown generation
05Support for multiple output formats including cheatsheets and usage guides
0640 GitHub stars
Use Cases
01Generating an up-to-date command cheatsheet for a CLI project
02Creating comprehensive technical reference manuals for API or skill definitions
03Automating documentation updates within a standard development workflow