codebase-documenter

A good README leads with a one-sentence explanation of what the project does, followed by a quick start that works in under five minutes, a visual file tree, common tasks, and troubleshooting. This Skill provides a README template with all these sections ready to customize.

Architecture documentation should cover system design with diagrams, directory structure with per-folder purpose, data flow, key design decisions with trade-offs, and module dependencies. The ARCHITECTURE template in this Skill provides a complete structure for these sections.

Each endpoint should document its purpose, authentication requirements, request and response formats with field tables, a working curl example, and common errors with solutions. The API template also covers rate limiting, error codes, and SDK examples.

Use inline comments to explain why complex logic, edge cases, or workarounds exist, and use external docs for architecture, setup, and API references. Avoid comments that merely restate what obvious code does.

The Skill provides templates, guidelines, and a structured workflow that an AI assistant follows to analyze your codebase and write documentation. The included index.js is a placeholder and does not perform automated parsing itself.