doc-generator

Generate README, JSDoc/TSDoc, API docs, and changelogs from source code.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces up-to-date technical documentation that stays consistent with the current codebase, avoiding stale READMEs, incorrect API docs, and missing inline guidance.

Core Features & Use Cases

  • Documentation generation across formats: Creates README content, JSDoc/TSDoc comments, API documentation, and changelogs for version updates.
  • Code-aligned accuracy: Reads and understands the actual source code to capture behavior, parameters, return values, side effects, and error conditions so the docs match reality.
  • Use cases: Documenting a function with proper JSDoc/TSDoc, generating a project README for an Express/API service, and producing changelog entries for a release.

Quick Start

Tell the Skill what you want to document (for example, the module or function name and the doc type like README, JSDoc/TSDoc, API docs, or changelog) and provide the relevant code or repository connection so it can generate copy-paste-ready documentation that matches the current implementation.

Frequently Asked Questions about doc-generator

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

FAQPage Schema
How do I generate JSDoc comments from existing source code?

Generating JSDoc comments from source code involves reading the actual implementation to extract behavior, parameters, return values, and error conditions, then producing copy-paste-ready inline documentation that matches the current codebase.

What is the best way to create a project README for an API service?

Creating a project README for an API service is done by reading the source code to capture behavior, parameters, and error conditions, then producing copy-paste-ready README content that maintains consistent terminology and reflects current implementation details.

How do I write changelog entries for a version release?

Writing changelog entries for a version release involves analyzing recent source code changes to summarize behavior updates, then producing release notes with consistent terminology that accurately reflect the current implementation details.

Can I generate API reference tables that match my current codebase?

Yes, generating API reference tables that match your current codebase is possible by providing the relevant source code so the tool can extract behavior, parameters, return values, and error conditions to produce accurate, copy-paste-ready API documentation.

Does generating technical documentation require manually specifying function behavior?

Generating technical documentation does not require manually specifying function behavior because the tool reads and understands the actual source code to capture behavior, side effects, and error conditions, ensuring the docs match reality without manual input.