Back to Details

docs-init

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Phase 1: Parallel Codebase Scouting

第一阶段：并行代码库侦察

You (main agent) must spawn scouts - subagents cannot spawn subagents.
  1. Run 
    ls -la
    to identify actual project directories
  2. Spawn 2-4 
    scout-external
    (preferred, uses Gemini 2M context) or 
    scout
    (fallback) via Task tool
  3. Target directories that actually exist - adapt to project structure, don't hardcode paths
  4. Merge scout results into context summary
你（主Agent）必须生成侦察子Agent - 子Agent不能再生成子Agent。
  1. 运行
    ls -la
    命令识别实际的项目目录
  2. 通过Task工具生成2-4个
    scout-external
    （优先选择，使用Gemini 2M上下文）或
    scout
    （备选）子Agent
  3. 以实际存在的目录为目标 - 根据项目结构调整，不要硬编码路径
  4. 将侦察子Agent的结果合并到上下文摘要中

Phase 2: Documentation Creation (docs-manager Agent)

第二阶段：文档创建（docs-manager Agent）

Pass the gathered file list to 
docs-manager
agent to create initial documentation:
  • docs/project-overview-pdr.md
    : Project overview and PDR (Product Development Requirements)
  • docs/codebase-summary.md
    : Codebase summary
  • docs/code-standards.md
    : Codebase structure and code standards
  • docs/system-architecture.md
    : System architecture
  • Update 
    README.md
    with initial documentation (keep it under 300 lines)
Use 
docs/
directory as the source of truth for documentation.
将收集到的文件列表传递给
docs-manager
Agent以创建初始文档：
  • docs/project-overview-pdr.md
    ：项目概述与PDR（产品开发需求）
  • docs/codebase-summary.md
    ：代码库摘要
  • docs/code-standards.md
    ：代码库结构与编码标准
  • docs/system-architecture.md
    ：系统架构
  • 更新
    README.md
    以包含初始文档（保持在300行以内）
将
docs/
目录作为文档的可信来源。

[CRITICAL] Code Evidence Requirements

[关键] 代码证据要求

All documentation MUST follow evidence rules from 
.claude/skills/feature-docs/SKILL.md
→ 
[CRITICAL] MANDATORY CODE EVIDENCE RULE
所有文档必须遵循
.claude/skills/feature-docs/SKILL.md
中的证据规则 → 
[关键] 强制代码证据规则

Quick Reference

快速参考

  • Format: 
    **Evidence**: {FilePath}:{LineNumber}
  • Status: ✅ Verified / ⚠️ Stale / ❌ Missing
  • Verification: 3-pass verification required before completion
  • 格式：
    **Evidence**: {FilePath}:{LineNumber}
  • 状态：✅ 已验证 / ⚠️ 已过时 / ❌ 缺失
  • 验证：完成前需要经过三轮验证

Evidence Verification Table (Required)

证据验证表（必填）

Entity/ComponentDocumented LinesActual LinesStatus
Entity.cs
L6-15L6-15✅ Verified
IMPORTANT: Do not start implementing.
实体/组件已记录行数实际行数状态
Entity.cs
L6-15L6-15✅ 已验证
重要提示：不要开始实施。

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
  • 始终规划并拆分多个小型待办任务
  • 始终添加一个最终审核待办任务，在最后审核已完成的工作，以发现任何需要修复或改进的地方