1.6 KiB
1.6 KiB
Init Workflow
Phase 1: Parallel Codebase Scouting
- Scan the codebase and calculate the number of files with LOC in each directory (skip credentials, cache or external modules directories, such as
.claude,.opencode,.git,tests,node_modules,__pycache__,secrets, etc.) - Target directories that actually exist - adapt to project structure, don't hardcode paths
- Activate
ck:scoutskill to explore the code base and return detailed summary reports to the main agent - Merge scout reports into context summary
Phase 2: Documentation Creation (docs-manager Agent)
CRITICAL: You MUST spawn docs-manager agent via Task tool with merged reports. Do not wait for user input.
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 guidelines
Phase 3: Size Check (Post-Generation)
After docs-manager completes:
- Run
wc -l docs/*.md 2>/dev/null | sort -rnto check LOC - Use
docs.maxLocfrom session context (default: 800) - For files exceeding limit:
- Report which files exceed and by how much
- docs-manager should have already split proactively
- If still oversized, ask user: split now or accept as-is?