SuperAPI AI 工具集

writing-plans

编程与开发

查看项目

更新于 10-15 10:43

技能介绍

用途

writing-plans 用于在动手写代码之前编写全面的实现计划。当你有规格说明或需求用于多步骤任务时使用。它假设执行计划的工程师对我们的代码库零上下文,且测试设计能力有限,因此计划需要记录他们需要知道的一切:每个任务要修改哪些文件、代码、测试、可能需要查阅的文档、如何测试。

主要能力

  • 将整个计划拆成小步骤任务,每步是一个 2-5 分钟的操作,例如“编写失败的测试”“运行它确认失败”“实现最少代码让测试通过”“运行测试确认通过”“Commit”。
  • 遵循 DRY、YAGNI、TDD、频繁 commit 原则。
  • 计划文档包含固定头部:功能名称、面向 AI 代理的工作者说明、目标、架构、技术栈。
  • 任务结构包含文件清单(创建、修改、测试的精确路径)和带复选框的步骤,每个代码步骤都展示完整代码块、精确命令和预期输出。
  • 包含范围检查:如果规格涵盖多个独立子系统,建议拆分为独立计划,每个计划应能独立产出可工作、可测试的软件。
  • 包含文件结构设计:在定义任务前先列出将创建或修改的文件及职责,优先小而专注的文件,按职责拆分而非按技术层级拆分。
  • 禁止占位符:不得写“待定”“TODO”“后续实现”“添加适当的错误处理”“类似任务 N”等,代码步骤必须有代码块。
  • 自检清单:规格覆盖度、占位符扫描、类型一致性检查,发现问题直接内联修复。
  • 执行交接:保存计划后提供子代理驱动(推荐)或内联执行两种方式。

使用方式

开始时宣布:“我正在使用 writing-plans 技能创建实现计划。”此技能应在专用 worktree 中运行(由 brainstorming 技能创建)。计划保存位置默认为 docs/superpowers/plans/YYYY-MM-DD-<feature-name>.md,用户对计划位置的偏好优先于此默认值。

计划文档头部格式:

# [功能名称] 实现计划

> **面向 AI 代理的工作者:** 必需子技能:使用 superpowers:subagent-driven-development(推荐)或 superpowers:executing-plans 逐任务实现此计划。步骤使用复选框(`- [ ]`)语法来跟踪进度。

**目标:** [一句话描述要构建什么]

**架构:** [2-3 句话描述方案]

**技术栈:** [关键技术/库]

任务结构示例:

### 任务 N:[组件名称]

**文件:**
- 创建:`exact/path/to/file.py`
- 修改:`exact/path/to/existing.py:123-145`
- 测试:`tests/exact/path/to/test.py`

- [ ] **步骤 1:编写失败的测试**

```python
def test_specific_behavior():
    result = function(input)
    assert result == expected
  • [ ] 步骤 2:运行测试验证失败

运行:pytest tests/path/test.py::test_name -v 预期:FAIL,报错 "function not defined"

  • [ ] 步骤 3:编写最少实现代码
def function(input):
    return expected
  • [ ] 步骤 4:运行测试验证通过

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

  • [ ] 步骤 5:Commit
git add tests/path/test.py src/path/file.py
git commit -m "feat: add specific feature"

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

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

1. 子代理驱动(推荐) - 每个任务调度一个新的子代理,任务间进行审查,快速迭代
2. 内联执行 - 在当前会话中使用 executing-plans 执行任务,批量执行并设置检查点

选哪种方式?”

如果选择子代理驱动:必需子技能为 superpowers:subagent-driven-development,每个任务一个新子代理 + 两阶段审查。

如果选择内联执行:必需子技能为 superpowers:executing-plans,批量执行并设有检查点供审查。

## 适用场景

- 已有规格说明或需求,需要将其转化为可执行的实现计划。
- 多步骤开发任务,需要在写代码前明确文件结构、任务分解和测试步骤。
- 需要让缺乏代码库上下文的工程师或 AI 代理按计划逐步实现。

## 限制

- 该技能应在专用 worktree 中运行(由 brainstorming 技能创建)。
- 如果规格涵盖多个独立子系统,应在头脑风暴阶段拆分为子项目规格,否则建议拆分为独立计划。
- 在现有代码库中应遵循已有模式,不要单方面重构大文件。
- 计划中不得包含占位符,代码步骤必须展示完整代码。
- 关于收费、价格、平台支持等信息暂未提供。