
Documentation Generator
- 233 installs
- 2 repo stars
- Updated January 25, 2026
- jorgealves/agent_skills
Generate and maintain API, module, and README documentation from code and conventions so shipping features does not leave docs stale or incomplete.
About
documentation-generator from jorgealves/agent_skills automates creation and updating of technical documentation from repository structure and code, reducing manual README drift and giving agents consistent patterns for API and module docs.
- Extract docs from code comments and types
- Generate API endpoint reference sections
- Keep README and module docs synchronized
- Standardize examples and parameter tables
- Agent-driven doc refresh on code changes
Documentation Generator by the numbers
- 233 all-time installs (skills.sh)
- +11 installs in the week ending Aug 2, 2026 (Skillselion tracking)
- Ranked #491 of 1,879 Documentation skills by installs in the Skillselion catalog
- Data as of Aug 2, 2026 (Skillselion catalog sync)
npx skills add https://github.com/jorgealves/agent_skills --skill documentation-generatorAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 233 |
|---|---|
| repo stars | ★ 2 |
| Last updated | January 25, 2026 |
| Repository | jorgealves/agent_skills ↗ |
What it does
Generate and maintain API, module, and README documentation from code and conventions so shipping features does not leave docs stale or incomplete.
Files
Documentation 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.
name: documentation-generator
version: 1.0.0
description: Analyzes source code to automatically generate technical documentation and architecture diagrams. Use to maintain up-to-date API references and onboarding materials for engineering teams.
inputs:
source_path:
type: string
required: true
output_format:
type: string
enum: [markdown, html, json]
default: markdown
outputs:
documentation_content:
type: string
capabilities:
- Docstring extraction.
- Mermaid.js diagram generation.
- Example inference from tests.
constraints:
- Accuracy depends on code clarity.
security:
- No code upload; local formatting only.
examples:
- input:
source_path: "./lib"
output:
documentation_content: "# API Reference"