documentation-generator

Generate READMEs, API references, and code comment standards from source code.

3|Updated Apr 18, 2026
One-click install
npx skills add https://github.com/garochee33/DSH --skill documentation-generator-garochee33
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-generator
Source: https://github.com/garochee33/DSH/tree/main/agents/skills/documentation-generator
Command: npx skills add https://github.com/garochee33/DSH --skill documentation-generator-garochee33

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the overhead of writing and maintaining project documentation by turning code, APIs, and project context into consistent, structured docs.

Core Features & Use Cases

  • README generation: Create polished project READMEs with quick start, features, tech stack, and documentation links.
  • API documentation: Produce OpenAPI, Swagger, and TypeDoc outputs for endpoints and TypeScript projects.
  • Code comment standards: Add JSDoc, ADRs, changelogs, and knowledge base sync patterns for maintainable engineering docs.
  • Use case: A team shipping a new service can use this Skill to generate the initial README, document endpoints, and standardize comment and ADR practices in one workflow.

Quick Start

Ask the skill to generate a complete README and API documentation set for your project based on its codebase and architecture notes.

Frequently Asked Questions about documentation-generator

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

FAQPage Schema
How do I generate a README and API documentation from source code?

Generate README and API documentation by providing the skill with your source code and architecture context, which it transforms into structured markdown outputs including quick start guides, features, tech stack, and endpoint references.

What's the best way to produce TypeDoc and OpenAPI outputs for a TypeScript project?

Produce TypeDoc and OpenAPI outputs by supplying your TypeScript codebase to the skill, which applies documentation-oriented tooling patterns to generate consistent, maintainable API references and endpoint specifications.

How do I standardize JSDoc code comments and architecture decision records?

Standardize JSDoc code comments and architecture decision records by applying the skill's code comment standards feature, which adds structured formatting patterns to your codebase for maintainable engineering documentation.

Can I generate changelogs and sync knowledge base documentation automatically?

Generate changelogs and sync knowledge base documentation using the skill's maintenance workflows, which apply structured markdown formatting to create consistent technical communication across your project documentation.

Do I need structured markdown formatting for project documentation generation?

Structured markdown formatting is required for project documentation generation, as the skill applies documentation-oriented tooling patterns to ensure consistent and maintainable technical communication across READMEs, API references, and code comments.

What does automated documentation generation do for a new service?

Automated documentation generation for a new service creates the initial README, documents API endpoints, and standardizes comment and architecture decision record practices in one complete workflow.