documentation-generator

Generates Markdown API documentation and Mermaid.js architecture diagrams from source code.

2|1|Updated Jan 25, 2026

Search Tags:#documentation #onboarding #code-analysis #API-reference #architecture-diagrams #Mermaid.js

Ready to run

npx skills add https://github.com/jorgealves/agent_skills --skill documentation-generator-jorgealves

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/jorgealves/agent_skills/tree/main/documentation-generator
Command: npx skills add https://github.com/jorgealves/agent_skills --skill documentation-generator-jorgealves

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill keeps software documentation accurate by automatically generating API references and architecture diagrams from the source code, eliminating manual doc maintenance.

Core Features & Use Cases

API Reference Generation: Creates up-to-date, navigable API references directly from code.
Architecture Diagrams: Produces diagrams (Mermaid.js) to visualize system components and relationships.
Onboarding & Knowledge Transfer: Generates onboarding materials and overview docs for new engineers and teams.

Quick Start

Run the documentation-generator against your project to produce a Markdown API reference and Mermaid diagrams.

Frequently Asked Questions about documentation-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automatically generate API documentation from source code?▼

You can automatically generate API documentation from source code by running a tool that parses your local codebase and outputs navigable Markdown API references without requiring external services.

What is the best way to create architecture diagrams for code onboarding?▼

Creating architecture diagrams for code onboarding is best handled by generating Mermaid.js visualizations directly from source code, which maps system components and relationships to help new engineers understand the project.

Can I integrate documentation generation into my CI workflow?▼

Yes, you can integrate documentation generation into your CI workflow to automatically produce up-to-date Markdown references and Mermaid diagrams during post-merge maintenance, ensuring docs stay accurate without manual updates.

Does this approach to generating API references work with large codebases?▼

Yes, generating API references from source code works with local codebases of any size, allowing you to extract up-to-date documentation and system visualizations without relying on external services.

What format are the generated architecture diagrams output in?▼

The generated architecture diagrams are output in Mermaid.js format, while the API references are output in Markdown, ensuring both documentation types are readable and version-controllable in standard repositories.