doc-gen

Generate API references, READMEs, and changelogs from code and configuration.

9|2|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/botlearn-ai/botlearn-skills --skill doc-gen-botlearn-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-gen
Source: https://github.com/botlearn-ai/botlearn-skills/tree/main/skills/doc-gen
Command: npx skills add https://github.com/botlearn-ai/botlearn-skills --skill doc-gen-botlearn-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automate the creation and maintenance of API references, READMEs, and changelogs across codebases, reducing manual toil and increasing documentation quality.

Core Features & Use Cases

  • Generate API documentation by analyzing source code, OpenAPI specs, and existing API surfaces.
  • Produce comprehensive READMEs with installation, quick-start, usage, configuration, and license sections.
  • Create Keep a Changelog-compliant release notes from commit history, PRs, and versioning signals.
  • Maintain style consistency and re-use existing project conventions to ensure cohesive documentation across documents.

Quick Start

Run the doc-gen workflow on a repository to generate a complete documentation package ready for publishing.

Frequently Asked Questions about doc-gen

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

FAQPage Schema
How do I generate API documentation from source code and OpenAPI specs?

Generate API documentation by analyzing source code, OpenAPI specs, and API surfaces to produce structured references for endpoints and schemas. The process verifies against actual source code to avoid fabricating behavior and ensures style consistency.

Can I automatically create a README with installation and usage sections from my repository?

Automatically produce comprehensive READMEs by analyzing your repository to generate installation, quick-start, usage, configuration, and license sections. The generated README preserves existing project conventions to maintain cohesive documentation style.

How do I generate changelog release notes from commit history?

Create Keep a Changelog-compliant release notes by analyzing commit history, PRs, and versioning signals. This approach extracts versioned notes from actual repository activity to maintain an accurate and maintainable changelog.

Does documentation generation work without fabricating API behavior?

Documentation generation verifies all content against actual source code, tests, and configuration to prevent fabricated behavior. It analyzes public exports and endpoints directly to produce runnable examples and accurate schema references.

What is the best way to maintain style consistency across API docs, READMEs, and changelogs?

Maintain style consistency by re-using existing project conventions during documentation generation. The process analyzes current documents and code to ensure cohesive formatting across API references, READMEs, and versioned changelogs.

Are there limitations when generating docs for complex codebases with custom configurations?

Documentation generation requires analyzing actual source, tests, and configuration to avoid fabricating behavior. Complex codebases must have clear public exports and accessible versioning signals to produce maintainable, version-aware documentation packages.