Codebase Documentation Skill

Generate and maintain a structured set of markdown files in docs/ that give AI agents (and humans) a fast, accurate understanding of a codebase without needing to search through source files.

Philosophy

The docs you produce are a map, not the territory. They should let an AI agent answer questions like "where does authentication happen?", "how does data flow from API to database?", or "what are the key abstractions?" — without reading every file. Optimize for navigability and accuracy over exhaustiveness.

When to Use This Skill

• User asks to document a codebase or project
• User wants to update existing docs after making changes
• User wants AI-friendly project documentation
• User mentions docs/ directory maintenance
• User wants architecture or structural documentation

Step 1: Assess the Codebase

Before writing anything, understand what you're documenting.