code-documenter

Solid

Expert documentation generator for coding projects. Analyzes codebases to create thorough, comprehensive documentation for developers and users. Supports incremental updates, multi-audience documentation, architecture decision records, and documentation health tracking. Works with any project type (APIs, CLIs, web apps, libraries). Use when you need to document a new project, update docs after adding features, or create comprehensive documentation for open source releases.

Data & Documents 103 stars 20 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
67
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Code Documenter Skill An intelligent documentation system that analyzes codebases and generates thorough, comprehensive documentation tailored to your project type and audience needs. ## Core Philosophy **Documentation serves readers, not authors.** Every decision about structure, depth, and content is evaluated from the reader's perspective: - Will this help them understand? - Will this help them succeed? - Will this answer their questions? - Does this earn its place? **Comprehensive without overwhelm.** Thorough coverage of what matters, ruthless cutting of what doesn't. The goal is complete, accurate, useful documentation—not exhaustive documentation of every line of code. **Documentation as code artifact.** Docs should be versioned, tested, and maintained with the same rigor as code. They're not afterthoughts; they're essential. ## When to Use This Skill **Primary use cases:** - After completing significant new work (epic, major feature, new app) - When shipping an open source project - When documentation has fallen out of sync with code - When onboarding requires better documentation - When setting up a new project properly **Not for:** - In-progress features (wait until stable) - Code comments or docstrings (this generates external docs) - API reference generation from code (use language-specific tools for that) ## Session Flow ### Mode Selection The skill operates in two modes: | Mode | When to Use ...

Details

Author
robertguss
Repository
robertguss/claude-code-toolkit
Created
6 months ago
Last Updated
1 weeks ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category