Analyze codebase and manage project documentation — init, update, summarize.
Analyze codebase and manage project documentation through scouting, analysis, and structured doc generation.
If invoked without arguments, use AskUserQuestion to present available documentation operations:
| Operation | Description |
|---|---|
init | Analyze codebase & create initial docs |
update | Analyze changes & update docs |
summarize | Quick codebase summary |
Present as options via AskUserQuestion with header "Documentation Operation", question "What would you like to do?".
| Subcommand | Reference | Purpose |
|---|---|---|
/ck:docs init |
references/init-workflow.md |
| Analyze codebase and create initial documentation |
/ck:docs update | references/update-workflow.md | Analyze codebase and update existing documentation |
/ck:docs summarize | references/summarize-workflow.md | Quick analysis and update of codebase summary |
Parse the user's message (text after the skill name) first word:
init → Follow the "init-workflow.md" section below under Reference Workflowsupdate → Follow the "update-workflow.md" section below under Reference Workflowssummarize → Follow the "summarize-workflow.md" section below under Reference Workflowsinit)Documentation lives in ./docs directory:
./docs
├── project-overview-pdr.md
├── code-standards.md
├── codebase-summary.md
├── design-guidelines.md
├── deployment-guide.md
├── system-architecture.md
└── project-roadmap.md
Use docs/ directory as the source of truth for documentation.
IMPORTANT: Do not start implementing code.
The following sections are inlined from the skill's reference files for Cursor compatibility.
.claude, .opencode, .git, tests, node_modules, __pycache__, secrets, etc.)@.cursor/skills/scout/SKILL.md to explore the code base and return detailed summary reports to the main agentCRITICAL: You (Cursor AI) must do this directly — no agent spawning available.
Pass the gathered context to docs-manager agent to create initial documentation:
README.md: Update README with initial documentation (keep it under 300 lines)docs/project-overview-pdr.md: Project overview and PDR (Product Development Requirements)docs/codebase-summary.md: Codebase summarydocs/code-standards.md: Codebase structure and code standardsdocs/system-architecture.md: System architecturedocs/project-roadmap.md: Project roadmapdocs/deployment-guide.md [optional]: Deployment guidedocs/design-guidelines.md [optional]: Design guidelinesAfter docs-manager completes:
wc -l docs/*.md 2>/dev/null | sort -rn to check LOCdocs.maxLoc from session context (default: 800)Follow @.cursor/skills/scout/SKILL.md to analyze the codebase and update docs/codebase-summary.md and respond with a summary report.
$1: Focused topics (default: all)
$2: Should scan codebase (Boolean, default: false)
<focused_topics>$1</focused_topics>
<should_scan_codebase>$2</should_scan_codebase>
docs/ directory as the source of truth for documentation..claude, .opencode, .git, tests, node_modules, __pycache__, secrets, etc.)@.cursor/skills/scout/SKILL.md to explore the code base and return detailed summary reportsRead all docs files directly — no parallel agents available in Cursor.
ls docs/*.md 2>/dev/null | wc -lwc -l docs/*.md 2>/dev/null | sort -rnCRITICAL: You (Cursor AI) must do this directly — no agent spawning available.
Pass the gathered context to docs-manager agent to update documentation:
README.md: Update README (keep it under 300 lines)docs/project-overview-pdr.md: Update project overview and PDRdocs/codebase-summary.md: Update codebase summarydocs/code-standards.md: Update codebase structure and code standardsdocs/system-architecture.md: Update system architecturedocs/project-roadmap.md: Update project roadmapdocs/deployment-guide.md [optional]: Update deployment guidedocs/design-guidelines.md [optional]: Update design guidelines<additional_requests> the user's message (text after the skill name) </additional_requests>
After docs-manager completes:
wc -l docs/*.md 2>/dev/null | sort -rn to check LOCdocs.maxLoc from session context (default: 800)Run validation to detect potential hallucinations:
node .claude/scripts/validate-docs.cjs docs/docs/ directory as the source of truth.