编写计划

概述

编写全面的实施计划，假设工程师对我们的代码库一无所知且品味堪忧。记录他们需要知道的一切：每个任务要接触哪些文件、代码、测试、可能需要检查的文档、如何测试。将整个计划分解为小任务。DRY。YAGNI。TDD。

假设他们是一位熟练的开发者，但几乎不了解我们的工具集或问题领域。假设他们不太了解良好的测试设计。

开始时声明： "我正在使用 writing-plans 技能来创建实施计划。"

保存计划到： docs/plans/YYYY-MM-DD-<feature-name>.md

范围检查

如果规范涵盖多个独立的子系统，它应该在头脑风暴阶段被拆分为子项目规范。如果没有，建议将其拆分为独立的计划——每个子系统一个计划。每个计划都应该独立产出可运行、可测试的软件。

文件结构

在定义任务之前，先规划将要创建或修改哪些文件，以及每个文件负责什么。这是分解决策被确定的地方。

设计具有清晰边界和明确定义接口的单元。每个文件应该有一个清晰的责任。
你能一次性在脑海中容纳的代码，你的推理效果就最好；文件越聚焦，你的编辑就越可靠。优先选择小而聚焦的文件，而不是做太多事情的大文件。
一起变化的文件应该放在一起。按责任拆分，而不是按技术层拆分。
在现有代码库中，遵循已建立的模式。如果代码库使用大文件，不要单方面重组——但如果你正在修改的文件已经变得难以管理，在计划中包含拆分是合理的。

这个结构指导任务分解。每个任务都应该产生独立的、有意义的自包含变更。

小任务粒度

每个步骤是一个动作（2-5 分钟）：

"编写失败的测试" - 步骤
"运行它以确保失败" - 步骤
"实现最小代码使测试通过" - 步骤
"运行测试并确保它们通过" - 步骤

计划文档头部

每个计划必须以这个头部开始：

[功能名称] 实施计划

目标： [一句话描述构建的内容]

架构： [关于方法的 2-3 句话]

技术栈： [关键技术/库]

任务结构

任务 N: [组件名称]

文件：

创建: exact/path/to/file.py
修改: exact/path/to/existing.py:123-145
测试: tests/exact/path/to/test.py
步骤 1: 编写失败的测试

def test_specific_behavior():
    result = function(input)
    assert result == expected

步骤 2: 运行测试以验证失败

运行: pytest tests/path/test.py::test_name -v 预期: 失败，显示 "function not defined"

步骤 3: 编写最小实现

def function(input):
    return expected

步骤 4: 运行测试以验证通过

运行: pytest tests/path/test.py::test_name -v 预期: 通过

记住

始终使用精确的文件路径
计划中包含完整代码（而不是"添加验证"）
精确的命令和预期输出
使用 @ 语法引用相关技能
DRY、YAGNI、TDD

计划审查循环

完成计划的每个块后：

分派计划文档审查子代理（参见 plan-document-reviewer-prompt.md），并提供精心制作的审查上下文——绝不是你的会话历史。这能让审查者专注于计划本身，而不是你的思考过程。
提供：块内容、规范文档路径
如果发现 ❌ 问题：
修复该块中的问题
重新分派审查者审查该块
重复直到 ✅ 批准
如果 ✅ 批准：继续下一个块（如果是最后一个块，则进入执行交接）

块边界：使用 ## Chunk N: <name> 标题来界定块。每个块应 ≤1000 行且逻辑上自包含。

审查循环指导：

编写计划的同一个代理修复它（保留上下文）
如果循环超过 5 次迭代，向人类寻求指导
审查者是顾问——如果你认为反馈不正确，解释你的分歧

执行交接

保存计划后：

writing-plans

Safety Notice

Copy this and send it to your AI assistant to learn

[功能名称] 实施计划

任务 N: [组件名称]

Source Transparency

Related Skills

tauri-v2

writing-plans

pandoc

vite-starter