doc-generator

Generate JSDoc comments, API docs, READMEs, and changelogs from source code.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/alexanderjamesmcleod/makecents --skill doc-generator-alexanderjamesmcleod
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/alexanderjamesmcleod/makecents/tree/main/src/skills/development/doc-generator.skill
Command: npx skills add https://github.com/alexanderjamesmcleod/makecents --skill doc-generator-alexanderjamesmcleod

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Auto-generate documentation, comments, and API docs directly from source code, ensuring consistency and reducing manual drafting time.

Core Features & Use Cases

  • Auto-create JSDoc/TSDoc comments from TypeScript/JavaScript sources.
  • Generate comprehensive API documentation, READMEs, and changelogs from code history.
  • Produce architecture diagrams and project documentation to support large codebases.

Quick Start

Run doc-generator <command> <path> to generate the appropriate documentation for your project.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I auto-generate API documentation from TypeScript source code?

To generate API documentation from TypeScript source code, run the doc-generator command targeting your project path to automatically produce JSDoc/TSDoc comments and comprehensive API docs directly from your codebase.

What is the best way to create a README and changelog from code history?

The best way to create a README and changelog from code history is to use an automated documentation generation tool that parses your source files and commit history to produce structured, comprehensive project documentation.

Can I generate architecture diagrams for large software codebases automatically?

Yes, you can generate architecture diagrams for large software codebases automatically by running the doc-generator tool against your project directory to produce visual project documentation.

Does this documentation generator work with bash scripts and web applications?

Yes, this documentation generator works with bash scripts, web applications, and CLI tools by analyzing source code to create modular comments, API docs, and structured outputs suitable for automation.

How do I keep documentation in sync with code without manual drafting?

To keep documentation in sync with code without manual drafting, use a frontmatter-based configuration tool that automatically generates documentation, comments, and API docs directly from your source files.