docs-generator

Audit codebases and generate CLAUDE.md with a structured docs/ directory.

Updated Jul 11, 2022
One-click install
npx skills add https://github.com/kvnxiao/.dotfiles --skill docs-generator-kvnxiao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-generator
Source: https://github.com/kvnxiao/.dotfiles/tree/main/claude/skills/docs-generator
Command: npx skills add https://github.com/kvnxiao/.dotfiles --skill docs-generator-kvnxiao

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically generates comprehensive project documentation by analyzing code and existing docs.

Core Features & Use Cases

  • Audit existing documentation to assess coverage and accuracy.
  • Analyze the codebase to detect architecture, dependencies, and common patterns.
  • Generate and maintain a CLAUDE.md as a living table of contents and bootstrap a structured docs/ directory with architecture, standards, and onboarding content.

Quick Start

Run the docs-generator on a repository to produce CLAUDE.md and the docs/ folder.

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 for my codebase?

It audits existing documentation to assess coverage and accuracy, analyzes the codebase to detect architecture and dependencies, then generates CLAUDE.md and a structured docs/ directory covering architecture, standards, and onboarding.

How do I create a CLAUDE.md file and organize my docs directory?

To create a CLAUDE.md and organize docs, the generator analyzes your code to produce a living table of contents in CLAUDE.md and bootstraps a structured docs/ directory with architecture, standards, and onboarding content.

Can I use an automated documentation generator for a large monorepo?

Yes, this automated documentation generator applies to diverse codebases from small repos to large monorepos, detecting architecture, patterns, and data flow to produce structured documentation at scale.

What is evidence-based documentation and how does it work for code analysis?

Evidence-based documentation works by auditing source code, detecting architectural patterns, and producing a structured CLAUDE.md plus a scalable docs/ hierarchy based on actual code analysis rather than manual input.

Do I need any dependencies or components to set up automated codebase documentation?

No dependencies or components are required to set up automated codebase documentation; you run the generator directly on a repository to produce the CLAUDE.md file and the docs/ folder structure.

What's the best way to identify and fill gaps in existing project documentation?

The best way to fill documentation gaps is to audit existing documentation for coverage and accuracy, then analyze the codebase to detect architecture and patterns, generating structured docs to cover missing areas.