docs-generator

Generate JSDoc/TSDoc comments, API references, and READMEs from TypeScript and JavaScript source code.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typedoc, jsdoc.

What problem does it solve?

Manual documentation is time-consuming, often outdated, and a bottleneck in development. This skill automates the creation and maintenance of various documentation types, ensuring your project always has accurate and comprehensive guides.

Core Features & Use Cases

  • Code Documentation: Automatically adds JSDoc/TSDoc comments to functions, components, and classes.
  • README Generation: Creates or updates project READMEs with installation, usage, and API references.
  • API Reference: Utilizes tools like TypeDoc or JSDoc to build comprehensive API documentation.
  • Use Case: After developing a new feature, use this skill to automatically generate JSDoc comments for new functions and update the project's README with the new API details, saving you hours of manual writing.

Quick Start

Generate documentation for all TypeScript files in the 'src' directory, focusing on public functions.

Frequently Asked Questions about docs-generator

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

FAQPage Schema
How do I automatically generate documentation from TypeScript and JavaScript code?

Automated documentation generation extracts code structure, types, and function signatures to produce JSDoc/TSDoc comments, API references, and README files. This skill analyzes your source code and creates comprehensive documentation that stays synchronized with your codebase, eliminating manual writing and outdated guides.

Can I generate API reference documentation with TypeDoc or JSDoc?

Yes. This skill integrates with TypeDoc and JSDoc tooling to build complete API reference documentation from your TypeScript and JavaScript projects. It processes function signatures, type definitions, and props to produce structured API guides automatically.

How do I add JSDoc comments to functions and classes automatically?

The skill analyzes function signatures, parameters, and return types to generate JSDoc/TSDoc blocks automatically. It adds documentation comments to functions, components, and classes in your source files, then updates your project README with the new API details.

What's the best way to keep README documentation in sync with code changes?

Automated documentation generation updates README files whenever your codebase evolves. By extracting current function signatures, types, and usage examples directly from source, this approach ensures README content reflects actual code without manual maintenance.

Does this work for generating component documentation in React or Vue projects?

Yes. The skill generates documentation for components by analyzing props, types, and function signatures in TypeScript and JavaScript files, producing component guides and API references applicable to React, Vue, and other JavaScript frameworks.

What happens if I have missing or incomplete type information in my code?

The skill processes available type definitions, function signatures, and JSDoc blocks to generate documentation. Projects with explicit TypeScript types or existing JSDoc produce richer output; incomplete type information may result in less detailed documentation, though the skill still generates usable guides.