Why is brevity a core principle of this skill?

The skill operates on the belief that documentation is only useful if it is read. It ruthlessly cuts unnecessary words and sections to ensure maximum scannability and impact.

Can I manually write API references using this tool?

No, the skill follows a strict principle that API references should be auto-generated from code signatures and tables rather than written as prose to ensure they remain accurate.

What types of documentation can this skill generate?

The skill generates three primary types: API references (extracted from code), How-To guides (tutorials with contracts), and Architecture overviews (high-level system design).

How does the skill handle existing documentation?

When run without a specific type argument, the skill reviews all existing documentation against the current code and automatically updates anything that has become stale.

Documentation Generator

Name: Documentation Generator
Author: JSai23

byJSai23

•

Aprendizaje y Documentación

Generates and maintains concise, high-impact project documentation including API references, how-to guides, and architecture overviews.

The doc skill streamlines the technical documentation process by enforcing a philosophy of extreme brevity and actionable clarity. It allows users to automatically extract API references from source code, create structured how-to tutorials that define system contracts, and maintain living architecture documents that evolve with the codebase. By focusing on Minimum Viable Documentation, it ensures that project information remains scannable, relevant, and free from the bloat that typically leads to documentation rot.

Características Principales

01High-level architecture documentation for system design and data flow.

021 GitHub stars

03Stale documentation detection to update existing files after significant code changes.

04Template-based How-To guide generation with prerequisite and contract definitions.

05Automated API reference extraction for functions, endpoints, and interfaces.

06Brevity enforcement to ensure every line of documentation serves a purpose.

Casos de Uso

01Establishing clear developer onboarding guides with explicit system expectations and common mistakes.

02Maintaining high-level system architecture overviews that stay synchronized with evolving codebases.

03Generating technical API references directly from source code signatures without manual writing.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jsai23/claude-tooling doc

For use in Claude.ai and ChatGPT

Download Skill