mcpField
W
writing-plans

writing-plans

github.com/bobmatnyc开发78340 次安装15 周前更新
代码仓库

关于 writing-plans

这项 skill 用于编写面向代码库经验有限的工程师的实施计划,明确文件路径、代码、测试和命令,并强调小步推进与频繁提交。

主要功能

  1. 01明确文件路径与代码
  2. 02拆分为短小任务
  3. 03先测试后实现
  4. 04列出命令及预期结果
  5. 05提供计划执行交接选项

适用场景

  1. 01为陌生代码库规划改动
  2. 02将实施过程拆成可测试任务
  3. 03将计划保存到 docs/plans

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/bobmatnyc/claude-mpm-skills --skill writing-plans

安装后在 Claude Code 中输入/writing-plans确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

metadata.json
references/
best-practices.md
plan-structure-templates.md

详细介绍

编写计划

概述

编写全面的实施计划,假设工程师对我们的代码库毫无了解,而且品味值得怀疑。记录他们需要知道的一切:每项任务要修改哪些文件、代码、测试、需要查阅的文档,以及如何测试。将整个计划拆分为易于执行的小任务。DRY。YAGNI。TDD。频繁提交。

假设他们是熟练的开发者,但几乎不了解我们的工具集或问题领域。假设他们不太了解如何设计优质测试。

开始时宣布:“我正在使用 Writing Plans 技能来创建实施计划。”

**上下文:**应在专用工作树中执行(由 brainstorming 技能创建)。

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

快速参考

**计划标题模板:**参见 计划结构与模板

**任务模板:**参见 计划结构与模板

**粒度指南:**每个步骤耗时 2–5 分钟。参见 最佳实践

核心原则

  • 始终使用精确文件路径——不要写“在用户模块中”,而要写“src/models/user.py”
  • 在计划中提供完整代码——不要只写“添加验证”,而要展示验证代码
  • 提供精确命令和预期输出——写出“pytest tests/file.py -v”,并说明会看到什么
  • 引用相关技能——使用 @ 语法:@skills/category/skill-name
  • DRY、YAGNI、TDD、频繁提交——每项任务都遵循这一模式

详细指南:最佳实践与指南

执行交接

保存计划后,提供执行方式选项:

“计划已完成并保存至 docs/plans/<filename>.md。有两种执行方式:

1. 子 Agent 驱动(当前会话)——我为每项任务派发新的子 Agent,在任务之间进行审核,快速迭代

2. 并行会话(单独执行)——开启新会话,使用 executing-plans,分批执行并设置检查点

你想采用哪种方式?”

如果选择子 Agent 驱动:

  • 使用 @skills/collaboration/subagent-driven-development
  • 保持在当前会话中
  • 每项任务使用新的子 Agent,并进行代码审核

如果选择并行会话:

  • 引导他们在工作树中开启新会话
  • 新会话使用 @skills/collaboration/executing-plans

请记住

  • 面向毫无上下文的工程师编写(明确说明所有内容)
  • 提供完整代码块,而不是仅给出指令
  • 提供精确命令和预期输出
  • 先测试,再实现,然后提交
  • 参考代码库中已有的模式
  • 将任务拆分为易于执行的小步骤(每步 2–5 分钟)

**需要示例?**参见 计划结构与模板,了解完整的任务示例。

**需要模式参考?**参见 最佳实践,了解错误处理、日志记录、测试设计等内容。

评论

支持 Markdown