Writing Plans

在接触代码之前,当有多步任务的规格或需求时使用。

安装

概览

什么是Writing Plans

Writing Plans 是一种专为复杂多步任务设计的开发辅助技能,旨在帮助开发者在接触实际代码前,为工程师提供清晰、详尽的实现蓝图。该工具假设目标开发者对当前项目代码库几乎一无所知,甚至可能缺乏良好的编码习惯或测试设计能力。因此,它要求生成者将整个实现过程分解为一系列小而具体的行动步骤,确保每一步都具备可执行性,通常耗时在2到5分钟之间。其核心理念是遵循 DRY(Don’t Repeat Yourself)、YAGNI(You Aren’t Gonna Need It)、TDD(Test-Driven Development)等最佳实践,并鼓励频繁提交以追踪进度。使用 Writing Plans 时,系统会首先声明正在使用该技能,并在一个专用的工作树(worktree)中运行,以确保环境的隔离性和专注度。最终生成的计划文档会被保存至 `docs/plans/` 目录下,采用日期和特性名称命名的 Markdown 文件,便于后续查阅和管理。 该计划文档的结构非常严谨,必须以一个标准化的头部开始,明确指出该计划的用途、目标、采用的架构思路以及关键技术栈。随后,每个具体任务都被独立列出,并精确指定需要创建、修改或测试的文件路径。对于每一个任务,Writing Plans 会引导开发者按照 TDD 的循环——先编写失败的测试用例,再运行验证其失败,接着实现最小化代码使测试通过,最后再次运行测试确认成功,并建议进行一次 Git 提交。这种结构化的方法不仅降低了新成员上手的门槛,也极大地提升了团队协作的效率与代码质量的一致性。

核心功能特点

  1. 将复杂需求拆解为2-5分钟即可完成的微小行动步骤
  2. 强制遵循TDD原则:先写失败测试,再实现最小化代码
  3. 提供精确的Git命令和预期输出,指导每一步操作
  4. 自动生成结构化的Markdown实现计划文档
  5. 支持两种执行模式:本会话内子代理驱动或并行会话批量执行

适用场景

Writing Plans 最适用于那些需要从零开始构建新功能、重构现有模块或引入重大变更的场景。当面对一个全新的特性需求,且负责实现的工程师对该项目的业务逻辑和技术栈尚不熟悉时,此工具能显著降低沟通成本和理解偏差。例如,在一个微服务架构的项目中,若需新增一个用户认证模块,使用 Writing Plans 可以系统地规划出从定义接口、编写单元测试、实现核心逻辑到集成验证的完整路径,确保每个环节都经过充分测试。同样,在进行数据库迁移或性能优化等重大改动时,它也能帮助团队提前规划好数据一致性保障、回滚方案及监控指标等关键事项。对于那些需要多人协作、版本控制严格且对代码质量有较高要求的敏捷开发环境而言,Writing Plans 提供了一个标准化、可追溯的开发流程框架,有助于提升整体交付效率和代码健壮性。