Documentation Generation

Name: Documentation Generation
Availability: InStock
Author: Kolb

Generate API references, READMEs, and architecture diagrams from code comments and types.

Updated Aug 23, 2026

Search Tags:#architecture #documentation #readme #types #generate #api-reference #code-comments

Ready to run

npx skills add https://github.com/mkolb22/zen-plugin --skill documentation-generation-mkolb22

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: Documentation Generation
Source: https://github.com/mkolb22/zen-plugin/tree/main/skills/documentation-generation
Command: npx skills add https://github.com/mkolb22/zen-plugin --skill documentation-generation-mkolb22

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often lags behind code, making it hard for teams to understand APIs, usage, and architecture just by looking at the repository.

Core Features & Use Cases

API Reference generation: derive API surfaces from JSDoc/TypeScript types, classes, and interfaces to produce ready-to-publish references.
README and onboarding content: create concise, accurate project READMEs that reflect current usage and setup.
Architecture documentation: synthesize high-level diagrams and component descriptions from code structure and dependencies.

Quick Start

Run the Documentation Generation skill on your project to produce API references, READMEs, and architecture diagrams from your codebase.

Frequently Asked Questions about Documentation Generation

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

FAQPage Schema

How do I generate API references from code comments and TypeScript types?▼

Generate API references by extracting signatures, JSDoc comments, and TypeScript types from classes and interfaces. This process derives the API surface to produce ready-to-publish reference templates directly from your codebase.

What is the best way to create a README that reflects current project setup?▼

Creating a README is best handled by synthesizing code structure and dependencies. This approach generates concise onboarding content that accurately reflects current project usage and setup instructions.

Can I generate architecture diagrams from my code structure?▼

Yes, you can generate architecture diagrams by analyzing your code structure and dependencies. This synthesis produces high-level visual diagrams and component descriptions for your software projects.

Does documentation generation work across different languages and CI workflows?▼

Documentation generation applies to software projects across various languages and CI workflows. It extracts details from code comments and types to produce API templates, README sections, and architecture diagrams.

Why does my README not match the current API surface of my repository?▼

Your README may not match the API surface because documentation often lags behind code. Generating docs directly from code, comments, and types ensures your README and references reflect the current repository state.