skills.rest
haJ1t
haJ1tCOMMUNITY
Explore all skills by this author →
GitHub

documentation-generator

Generates API references, READMEs, architecture docs, and ADRs from codebases.

Updated May 24, 2026
Search Tags:#codebase analysis#code documentation#API reference#auto documentation#README generation
One-click install
npx skills add https://github.com/haJ1t/senior-dev-squad-skills --skill documentation-generator-haj1t
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/haJ1t/senior-dev-squad-skills/tree/main/plugins/senior-dev-squad/skills/documentation-generator
Command: npx skills add https://github.com/haJ1t/senior-dev-squad-skills --skill documentation-generator-haj1t

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill solves the problem of manually generating and maintaining documentation for codebases, ensuring that documentation stays in sync with the code.

Core Features & Use Cases

  • Automated Documentation: Generates API references, READMEs, architecture docs, and ADRs from code.
  • Documentation Synchronization: Ensures that documentation is up-to-date with the codebase.
  • Use Case: Ideal for setting up documentation infrastructure for a new project or updating existing documentation.

Quick Start

Generate documentation for the current codebase using the documentation-generator skill.

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 references and READMEs from a codebase automatically?▼

To generate API references and READMEs from a codebase automatically, you need a tool that analyzes your OpenAPI or GraphQL schemas and codebase docstrings to extract structural details and produce formatted documentation.

What is the best way to keep code documentation in sync with my codebase?▼

Keeping code documentation in sync with your codebase is best achieved through CI/CD integration that automatically regenerates API references and architecture docs whenever code changes are committed.

Does auto documentation generation work with OpenAPI and GraphQL schemas?▼

Auto documentation generation works with OpenAPI and GraphQL schemas by parsing these structured definitions alongside your codebase docstrings to automatically build accurate API references.

What do I need to generate architecture docs and ADRs from my code?▼

To generate architecture docs and ADRs from your code, you need well-maintained codebase docstrings and valid OpenAPI or GraphQL schemas available for the documentation generator to analyze.

Can I use automated documentation for an existing project or only new ones?▼

Automated documentation can be used for both setting up documentation infrastructure for a new project and updating existing documentation to ensure it stays synchronized with your current codebase.

Related Skills

Explore More Software Engineering Skills→
armanzeroeightarmanzeroeight
29

api-docs-generator

Generate API documentation from code into HTML or JSON formats.

Community
Intermediate
Muath2000Muath2000

technical-writer

Generate READMEs, ADRs, guides, and API references with Markdown standards.

Community
Advanced
cryborg1211cryborg1211

Explore Codebase

Map codebase modules, dependencies, and relationships into a knowledge graph.

Community
Intermediate
jinwoonghongjinwoonghong

moai-docs-generation

Generate technical documentation from source code and Markdown using Sphinx, MkDocs, and Docusaurus.

Community
Advanced