docs-init
Original:🇺🇸 English
Translated
[Docs] ⚡⚡⚡⚡ Analyze the codebase and create initial documentation
28installs
Sourceduc01226/easyplatform
Added on
NPX Install
npx skill4agent add duc01226/easyplatform docs-initTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Phase 1: Parallel Codebase Scouting
You (main agent) must spawn scouts - subagents cannot spawn subagents.
- Run to identify actual project directories
ls -la - Spawn 2-4 (preferred, uses Gemini 2M context) or
scout-external(fallback) via Task toolscout - Target directories that actually exist - adapt to project structure, don't hardcode paths
- Merge scout results into context summary
Phase 2: Documentation Creation (docs-manager Agent)
Pass the gathered file list to agent to create initial documentation:
docs-manager- : Project overview and PDR (Product Development Requirements)
docs/project-overview-pdr.md - : Codebase summary
docs/codebase-summary.md - : Codebase structure and code standards
docs/code-standards.md - : System architecture
docs/system-architecture.md - Update with initial documentation (keep it under 300 lines)
README.md
Use directory as the source of truth for documentation.
docs/[CRITICAL] Code Evidence Requirements
All documentation MUST follow evidence rules from →
.claude/skills/feature-docs/SKILL.md[CRITICAL] MANDATORY CODE EVIDENCE RULEQuick Reference
- Format:
**Evidence**: {FilePath}:{LineNumber} - Status: ✅ Verified / ⚠️ Stale / ❌ Missing
- Verification: 3-pass verification required before completion
Evidence Verification Table (Required)
| Entity/Component | Documented Lines | Actual Lines | Status |
|---|---|---|---|
| L6-15 | L6-15 | ✅ Verified |
IMPORTANT: Do not start implementing.
IMPORTANT Task Planning Notes
- Always plan and break many small todo tasks
- Always add a final review todo task to review the works done at the end to find any fix or enhancement needed