doc-generator

Generate README, JSDoc comments, and API documentation from codebases.

5|Updated Apr 8, 2026
One-click install
npx skills add https://github.com/JansenAnalytics/claudex --skill doc-generator-jansenanalytics
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-generator
Source: https://github.com/JansenAnalytics/claudex/tree/main/skills/doc-generator
Command: npx skills add https://github.com/JansenAnalytics/claudex --skill doc-generator-jansenanalytics

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Many development teams waste hours documenting code, keeping READMEs up-to-date, and syncing API references as code evolves.

Core Features & Use Cases

  • Auto-generate README files by scanning project structure and detected frameworks.
  • Generate JSDoc/TSDoc comments for undocumented functions and provide consistent API docs.
  • Create API documentation from Express/Fastify/REST routes and keep docs in sync with code changes.
  • Reference best-practices and templates to ensure documentation quality across languages.

Quick Start

Use the doc-generator to generate README.md, JSDoc comments, and API documentation for your project in its root.

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 README files from my project structure?

To auto-generate README files, the scanner analyzes your project structure and detected frameworks to produce a formatted README.md document directly in the project root. It automates documentation by reading the codebase to maintain synchronization with changes.

Can I automatically generate JSDoc comments for undocumented functions?

Yes, you can generate JSDoc comments for undocumented functions by parsing the codebase. The tool analyzes JavaScript code to automatically add consistent JSDoc or TSDoc comments, ensuring standardized inline documentation across the project.

How do I create API documentation from Express or Fastify routes?

You create API documentation from Express or Fastify routes by applying language parsers to detect REST endpoints. The generator scans the route definitions to output API docs and keeps the references in sync with subsequent code changes.

Do I need language parsers to generate documentation for my codebase?

Yes, language parsers and doc tooling are required to parse code and generate documentation. These parsers enable the system to scan software projects of any size, extract structure, and maintain synchronization with code changes.

What is the best way to keep API docs in sync with code changes?

The best way to keep API docs in sync with code changes is to use automated documentation synchronization. The generator continuously parses code updates and modifies the API references and READMEs to reflect the latest codebase state.