Loading...
Loading...
Compare original and translation side by side
references/step-template.mdreferences/step-template.mddigraph blueprint {
rankdir=TB
node [shape=box, style=rounded, fontname="Helvetica", fontsize=10]
edge [fontname="Helvetica", fontsize=9]
explore [label="Explore codebase\n& discover tools"]
confirm [label="Confirm tool chain\nwith user"]
clarify [label="Clarify requirements"]
gate [label="Planning gate\nready?", shape=diamond]
fastappr [label="Fast-path\napproach?", shape=diamond]
propose [label="Propose 2-3\napproaches"]
pick [label="User picks\napproach"]
assess [label="Assess complexity"]
generate [label="Generate plan"]
fastrev [label="Fast-path\nreview?", shape=diamond]
review [label="Adversarial review\n(subagent)"]
passed [label="Review\npassed?", shape=diamond]
done [label="Plan ready\nfor execution", shape=doublecircle]
explore -> clarify
clarify -> confirm
confirm -> gate
gate -> fastappr [label="yes"]
gate -> clarify [label="no — gaps remain"]
fastappr -> assess [label="yes — single\nobvious strategy"]
fastappr -> propose [label="no"]
propose -> pick
pick -> assess
assess -> generate
generate -> fastrev
fastrev -> done [label="≤2 steps"]
fastrev -> review [label=">2 steps"]
review -> passed
passed -> done [label="yes"]
passed -> generate [label="no — fix issues"]
}digraph blueprint {
rankdir=TB
node [shape=box, style=rounded, fontname="Helvetica", fontsize=10]
edge [fontname="Helvetica", fontsize=9]
explore [label="Explore codebase\n& discover tools"]
confirm [label="Confirm tool chain\nwith user"]
clarify [label="Clarify requirements"]
gate [label="Planning gate\nready?", shape=diamond]
fastappr [label="Fast-path\napproach?", shape=diamond]
propose [label="Propose 2-3\napproaches"]
pick [label="User picks\napproach"]
assess [label="Assess complexity"]
generate [label="Generate plan"]
fastrev [label="Fast-path\nreview?", shape=diamond]
review [label="Adversarial review\n(subagent)"]
passed [label="Review\npassed?", shape=diamond]
done [label="Plan ready\nfor execution", shape=doublecircle]
explore -> clarify
clarify -> confirm
confirm -> gate
gate -> fastappr [label="yes"]
gate -> clarify [label="no — gaps remain"]
fastappr -> assess [label="yes — single\nobvious strategy"]
fastappr -> propose [label="no"]
propose -> pick
pick -> assess
assess -> generate
generate -> fastrev
fastrev -> done [label="≤2 steps"]
fastrev -> review [label=">2 steps"]
review -> passed
passed -> done [label="yes"]
passed -> generate [label="no — fix issues"]
}references/tool-discovery.mdDiscovered tools for this project:
1. Package manager: uv (from uv.lock)
2. Test runner: pytest (from pyproject.toml [tool.pytest])
3. Linter: ruff check . (from pyproject.toml [tool.ruff])
4. Formatter: ruff format --check . (from pyproject.toml [tool.ruff.format])
5. Type checker: mypy . (from pyproject.toml [tool.mypy])
Add, remove, or reorder? (or confirm to proceed)references/tool-discovery.mdDiscovered tools for this project:
1. Package manager: uv (from uv.lock)
2. Test runner: pytest (from pyproject.toml [tool.pytest])
3. Linter: ruff check . (from pyproject.toml [tool.ruff])
4. Formatter: ruff format --check . (from pyproject.toml [tool.ruff.format])
5. Type checker: mypy . (from pyproject.toml [tool.mypy])
Add, remove, or reorder? (or confirm to proceed)references/step-template.mdundefinedreferences/step-template.mdundefined| Category | Tool | Command |
|---|---|---|
| Test runner | [discovered] | |
| Linter | [discovered] | |
| Type checker | [discovered] | |
| Formatter | [discovered] | |
| Category | Tool | Command |
|---|---|---|
| Test runner | [discovered] | |
| Linter | [discovered] | |
| Type checker | [discovered] | |
| Formatter | [discovered] | |
**Step generation rules**:
- Number steps sequentially starting from 1.
- Write clear, specific titles that describe the deliverable ("Add user authentication endpoint"), not the activity ("Work on authentication").
- Write acceptance criteria that are concrete and testable. Avoid vague criteria like "code is clean" or "performance is good." Use measurable conditions: "Response time under 200ms for 95th percentile," "All validation errors return 422 with field-level messages."
- In Phase 1 (Build), describe intent per the prose-first approach. Specify what to create, modify, and test. Reference existing code patterns where applicable ("Follow the same repository pattern used in `src/repos/product_repo.py`").
- In Phase 2 (Adversarial Review), write step-specific review questions targeting the most likely failure modes, but also include broader integration questions: Does this change fit naturally in the existing codebase? Does it follow established conventions and patterns? Could it break or degrade anything outside its immediate scope? The review is a thorough, critical code review of the work done — not just an acceptance criteria checklist. The goal is to eliminate all issues introduced by the build phase before proceeding.
- In Phase 3 (Verification), include the full checklist with tool commands from the confirmed tool chain. Add step-specific verification items beyond the standard checks.
**Dependency tracking**: If a step depends on artifacts from a previous step, state the dependency explicitly in the objective. Example: "Depends on Step 2 (user repository). Uses the `UserRepository` interface defined there."
**Writing the milestone folder** (when applicable):
- Create one file per milestone: `01_milestone-name.md`, `02_milestone-name.md`, etc.
- Each milestone file follows the same structure (header, tool chain, steps).
- Add a root `README.md` in the plan folder that lists milestones in order with one-sentence descriptions.
- Keep milestones to 3-5 steps each. If a milestone has more, split it.
**步骤生成规则**:
- 步骤从1开始顺序编号
- 编写清晰具体的标题,描述交付物(例如「新增用户认证端点」),而非活动(例如「做认证相关工作」)
- 验收标准要具体可测,避免「代码整洁」「性能良好」这类模糊标准,使用可量化条件:「95分位响应时间低于200ms」「所有校验错误返回422状态码和字段级错误提示」
- 第一阶段(构建)按照文字优先的原则描述意图,说明需要创建、修改、测试的内容,可参考现有代码模式(例如「遵循`src/repos/product_repo.py`中使用的仓储层模式」)
- 第二阶段(对抗性评审)编写针对该步骤最可能故障模式的评审问题,同时包含更广泛的集成问题:该变更是否适配现有代码库?是否遵循已有的规范和模式?是否会破坏或影响其直接范围外的功能?评审是对完成工作的全面严格代码评审,不只是验收标准检查清单,目标是在推进前消除构建阶段引入的所有问题
- 第三阶段(验证)包含已确认工具链的完整检查命令清单,在标准检查之外补充步骤特有的验证项
**依赖跟踪**:如果某个步骤依赖前置步骤的产物,在目标中明确说明依赖关系,例如:「依赖步骤2(用户仓储层),使用其中定义的`UserRepository`接口」。
**里程碑文件夹编写规则**(适用时):
- 每个里程碑对应一个文件:`01_milestone-name.md`、`02_milestone-name.md`等
- 每个里程碑文件遵循相同结构(头部、工具链、步骤)
- 在计划文件夹根目录添加`README.md`,按顺序列出所有里程碑及一句话说明
- 每个里程碑包含3-5个步骤,超过则拆分{{PLANNING_CONTEXT}}references/plan-review-subagent.md{{PLAN_PATH}}{{PROJECT_ROOT}}{{PLANNING_CONTEXT}}references/plan-review-subagent.md{{PLANNING_CONTEXT}}references/plan-review-subagent.md{{PLAN_PATH}}{{PROJECT_ROOT}}{{PLANNING_CONTEXT}}references/plan-review-subagent.mddocs/plans/YYYY-MM-DD-<topic>-plan.mddocs/plans/2026-03-15-user-auth-plan.mddocs/plans/YYYY-MM-DD-<topic>-plan.mddocs/plans/2026-03-15-user-auth-plan.mddocs/plans/YYYY-MM-DD-<topic>/docs/plans/2026-03-15-user-auth/
README.md
01_data-layer.md
02_api-endpoints.md
03_frontend-integration.mdREADME.mddocs/plans/YYYY-MM-DD-<topic>/docs/plans/2026-03-15-user-auth/
README.md
01_data-layer.md
02_api-endpoints.md
03_frontend-integration.mdREADME.mdblueprint:executereferences/step-template.mdblueprint:executereferences/step-template.mdreferences/step-template.mdreferences/tool-discovery.mdreferences/plan-review-subagent.mdreferences/step-template.mdreferences/tool-discovery.mdreferences/plan-review-subagent.md