What documentation formats are supported?

It currently generates standard Markdown files including README.md, API.md, MIGRATION.md, and EXAMPLES.md.

Can I customize the generated documentation templates?

Yes, the skill uses customizable templates that allow you to adapt the output to match your specific project's branding or structural requirements.

How does the skill generate API documentation?

It parses the frontmatter and markdown structure of your skill and command files to extract arguments, descriptions, and usage patterns directly from your source code.

Will this tool overwrite my existing README.md?

The skill includes a safety check that identifies existing files and prompts for user confirmation before performing any overwrite operations.

Does it support version history?

The migration guide feature specifically analyzes git history between specified versions to automatically identify breaking changes and new features.

Auto-Documentation Generator

Name: Auto-Documentation Generator
Author: jrc1883

byjrc1883

•

Learning & Documentation

Generates and updates comprehensive project documentation, including READMEs, API references, and migration guides, through automated codebase analysis.

The Auto-Documentation Generator is a specialized skill for Claude Code designed to eliminate the manual overhead of maintaining technical documentation. By performing deep analysis of a plugin's repository structure, skill definitions, and command frontmatter, it automatically constructs standardized README files, detailed API documentation, and migration guides. It leverages git history to identify breaking changes and new features for release notes, ensuring that your documentation remains perfectly synchronized with your implementation. This tool is essential for developers who want to maintain professional-grade project visibility without diverting time from core development tasks.

Key Features

01Interactive validation and confirmation prompts to prevent accidental overwrites

02Deep API reference extraction from skill and command source files

03Template-driven output for consistent project styling

04Automated README generation with dynamic feature and command listings

055 GitHub stars

06Git-powered migration guide generation highlighting breaking changes

Use Cases

01Generate version-to-version migration guides and release notes from git history

02Bootstrap documentation for newly created Claude Code plugin packages

03Synchronize API references and READMEs after significant feature updates

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jrc1883/popkit-claude pop-auto-docs

For use in Claude.ai and ChatGPT

Download Skill