documentation-generator

Generate README, API docs, and architecture guides from codebases.

Updated Apr 8, 2026

Search Tags:#automation #templates #documentation #readme #docs #api-docs

Ready to run

npx skills add https://github.com/zm2231/personal-os-cowork --skill documentation-generator-zm2231

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/zm2231/personal-os-cowork/tree/main/.claude/skills/documentation-generator
Command: npx skills add https://github.com/zm2231/personal-os-cowork --skill documentation-generator-zm2231

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually maintaining documentation for software projects is time-consuming and prone to drift as code evolves.

Core Features & Use Cases

Automated README generation from code, tests, and specifications
API documentation generation from OpenAPI specifications
Developer guides and architecture documentation extraction
Documentation validation and drift detection

Quick Start

Provide the project path to the tool and run the documentation generator to produce README, API docs, and developer guides.

Frequently Asked Questions about documentation-generator

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

FAQPage Schema

How do I generate API documentation from an OpenAPI specification?▼

You can generate API documentation by providing the tool with your codebase path and OpenAPI specifications. The tool extracts specs and tests to produce API docs, README files, and architecture guides automatically.

What is the best way to keep documentation consistent with code as it evolves?▼

To keep documentation consistent, this tool validates generated docs against your codebase and detects drift. It extracts docstrings and tests to ensure your README and API docs match the current code state.

How do I automatically generate a README from code and tests?▼

You can automatically generate a README by running the documentation generator on your project path. It extracts docstrings, tests, and API specs to produce a README and developer guides without manual writing.

Can I extract architecture guides and developer documentation from an existing codebase?▼

Yes, you can extract architecture guides and developer documentation by pointing the tool to your project path. It analyzes the code, tests, and specifications to generate comprehensive architecture documentation.

Does the documentation generator work for libraries and APIs, or only standalone software projects?▼

The documentation generator works for APIs, libraries, and software projects. It extracts docstrings and API specs to produce README files, API docs, and architecture guides tailored to your specific project type.

Why does my documentation drift from my code, and how can I detect it?▼

Documentation drifts when manual updates lag behind code changes. This tool detects drift by validating generated documentation against the current codebase, ensuring your README and API docs remain consistent.