关于 create-plan
面向需要作出重要项目决策的团队,使用简明 ADR 和实施计划记录决策与后续工作,并控制计划范围。
主要功能
- 01记录决策状态与权衡
- 02将计划关联到 ADR
- 03按顺序列出任务和验证步骤
- 04检查范围与复杂度
适用场景
- 01记录架构决策
- 02决策后规划实施工作
- 03检查计划是否包含多余任务
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ maxedapps/ agent-skills --skill create-plan安装后在 Claude Code 中输入/create-plan确认已加载。
详细介绍
创建计划
仅制定计划;不要实施。
文件
决策及其计划保存在项目的 adrs/ 文件夹中。如果项目已采用其他 ADR 布局,则遵循该布局。
adrs/NNNN-<slug>.md:决策。使用下一个可用编号,绝不重新编号。adrs/NNNN-<slug>.plan.md:实施该决策的计划。
无需做出实际决策的小改动不需要这些文件。直接完成,或在聊天中商定方案即可。
ADR
保持简短,通常不超过一页:
- 状态: Proposed、Accepted 或 Superseded by NNNN
- 背景: 问题及其约束
- 决策: 我们将采取的做法
- 备选方案: 始终包含可行的最简单方案,并说明选择或不选择它的原因
- 后果: 我们接受的权衡
新 ADR 的状态设为 Proposed。只有用户批准后,才将其标记为 Accepted。决策发生变化时,应编写一份取代旧 ADR 的新 ADR,而不是改写已接受的历史记录。
计划
- 状态: Draft、Ready、In progress 或 Done
- 目标: 完成时的状态,以及不在范围内的内容
- 任务: 按顺序列出。每项任务都要说明要做哪些更改、从哪里着手、如何验证,以及是否已完成。验证包括需要添加或运行的高价值测试,以及重要的手动检查(例如用于 UI 的 agent-browser)。
- 待解决问题: 需要用户决定的事项
保持简单
- 根据制定计划的需要研究代码和文档,不要做多余的研究。
- 选择满足目标的最简单设计。不要添加推测性的选项、备用方案、抽象或“以后再做”的任务。
- 保存前,删除所有与目标无关的任务。
- 如果范围、行为或架构方面的选择确实存在歧义,应询问用户,而不是自行猜测。
- 对计划的每条反馈都要审视:它解决的是真实且可能出现的问题,还是只会增加复杂性?不确定时,询问用户。
评论
支持 Markdown