codebase-documenter
SolidUse this skill when the user wants to understand, document, or explain a codebase — even if they don't say "document" explicitly. Trigger on: "explain this codebase", "how does this project work", "create onboarding docs", "document the architecture", "I'm new to this repo", "generate a codebase overview", or any request to understand unfamiliar code. Produces a single docs/CODEBASE.md with architecture, components, data flow, setup instructions, and a recommended reading path for new developers. Supports quick/standard/deep depth levels and incremental updates.
Install
Quality Score: 83/100
Skill Content
Details
- Author
- opencue
- Repository
- opencue/cuecards
- Created
- 2 months ago
- Last Updated
- today
- Language
- TypeScript
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
codebase-documenter
Generates comprehensive documentation explaining how a codebase works, including architecture, key components, data flow, and development guidelines. Use when user wants to understand unfamiliar code, create onboarding docs, document architecture, or explain how the system works.
codebase-onboarding
Generates a single, deeply researched ONBOARDING.md at the root of an open source (or internal) codebase, written for a brand-new contributor. Use this whenever someone wants to understand, explore, ramp up on, or document an unfamiliar repository — trigger phrases include "help me understand this codebase," "explain this repo," "onboard me to this project," "I just cloned this and I'm lost," "write an ONBOARDING.md," "what's the architecture here," "how is this repo organized," or any request to explain a project's purpose, tech stack, dependencies, architecture, or module layout. Also use it proactively whenever a user opens or references a repository they haven't worked in before and asks broad "what is this / how does this work" questions. Do NOT use this for narrow single-file explanations, API reference generation, or README-writing for a project the user is authoring themselves (that's promotional copy, not onboarding).
codebase-documenter
Scaffold project documentation (README, ARCHITECTURE, API, CODE_COMMENTS) from templates with documented standards. Use when bootstrapping docs for a new or under-documented codebase.