About documentation-generator
documentation-generator creates and updates technical documentation from source code locally. It is for software teams maintaining project docs, including API references and architecture overviews for new team members.
Key features
- 01Generate technical docs from source code
- 02Update API documentation
- 03Create architecture diagrams and overviews
- 04Run locally without uploading source code
Use cases
- 01Refresh API docs after feature work
- 02Prepare architecture overviews for new team members
- 03Maintain a project's technical documentation
Install
Copy the command and run it in a terminal.
$
npx skills add https:/After installing, type/documentation-generatorin Claude Code to confirm it loaded.
Bundled filesskill.yaml
Details
From the project READMEDocumentation Generator
Purpose and Intent
The documentation-generator ensures that software projects remain maintainable by automatically creating and updating technical documentation directly from the source code.
When to Use
- Post-Development: Run after a feature is completed to ensure the API docs are up to date.
- Onboarding: Use to generate architecture diagrams and overviews for new team members.
When NOT to Use
- High-Level Strategy: This tool generates technical docs; it cannot write "Business Requirements" or "Product Vision" documents.
Security and Data-Handling Considerations
- Operates locally; does not upload source code to external servers.
Comments
Markdown supported