skills.rest
tsurutan
tsurutanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-generator

Generate inline and standalone documentation from JavaScript, TypeScript, Python, and Go code.

Updated Nov 28, 2025
Search Tags:#documentation#README#generate#JSDoc#code-comments#TSdoc#API-reference
One-click install
npx skills add https://github.com/tsurutan/claude-code-tutorial --skill doc-generator-tsurutan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/tsurutan/claude-code-tutorial/tree/main/.claude/skills/doc-generator
Command: npx skills add https://github.com/tsurutan/claude-code-tutorial --skill doc-generator-tsurutan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Code documentation is often neglected or created manually, leading to outdated information and wasted developer time. This skill automates generation of inline docs (JSDoc/TSDoc/Docstrings), READMEs, and API references directly from your codebase, reducing manual toil.

Core Features & Use Cases

  • Inline documentation generation: Generates JSDoc/TSDoc/Docstring comments from functions, classes, and interfaces.
  • Standalone docs generation: Creates README.md, API references, and CHANGELOGs automatically.
  • Use Case: On a new project, auto-generate up-to-date documentation from the source to accelerate onboarding and reduce maintenance effort.

Quick Start

Use the doc-generator to generate JSDoc comments for all TypeScript files in src/ and create a README.md and API reference for the 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 JSDoc and TSDoc comments from my TypeScript codebase?▼

Auto-generate JSDoc and TSDoc comments directly from your TypeScript source code by scanning functions, classes, and interfaces. The doc-generator analyzes your code structure and produces inline documentation comments that match your project's conventions, eliminating manual comment writing.

Can I generate a README and API reference automatically from my code?▼

Yes. Generate standalone documentation including README.md and API references directly from your source code. The Skill creates template-driven output validated against your codebase, producing publish-ready documentation without manual effort.

What languages and documentation formats does the generator support?▼

The generator supports JavaScript, TypeScript, Python, and Go. It produces inline formats (JSDoc, TSDoc, Docstrings, GoDoc) and standalone documents (README.md, API references, CHANGELOG.md), covering multiple language ecosystems and documentation standards.

How does automatic documentation ensure accuracy with my source code?▼

The doc-generator validates generated documentation against your source code during generation. This validation ensures consistency between inline docs, README content, and API references, keeping documentation synchronized with actual code changes.

Can I use this to speed up onboarding for new projects?▼

Yes. Generate up-to-date documentation from your source immediately upon project creation. Complete inline docs and standalone references accelerate developer onboarding and reduce ongoing maintenance by keeping docs synchronized automatically.

Does the tool support template-driven documentation output?▼

Yes. The doc-generator uses templates to drive documentation output format and structure. Templates let you customize how README, API references, and CHANGELOG documents are generated while maintaining consistency across your project documentation.

Related Skills

Explore More Software Engineering Skills→
masrurimzmasrurimz

doc-writer

Generate JSDoc/TSDoc comments, READMEs, and API documentation across codebases.

Community
Basic
j0KZj0KZ

release-publishing-workflow

Automate version bumps, CHANGELOG updates, npm publishing, and git tagging for a multi-package MCP monorepo.

Community
Advanced
docs-plusdocs-plus
88

setup-pre-commit

Configure Husky pre-commit hooks with lint-staged and Prettier for JavaScript and TypeScript repositories.

Official
Intermediate
RorySullivan1RorySullivan1

developer-agent-authoring

Design language-specific developer agents for coding, review, and verification workflows.

Community
Advanced