SuperAPI AI 工具集

writing-plans

编程与开发

查看项目

更新于 10-16 06:10

技能介绍

用途

writing-plans 用于在设计已经完成之后,为工程师编写一份详尽的实现计划。它的核心假设是:执行计划的工程师虽然技术熟练,但对当前代码库、工具链和问题域几乎一无所知,而且对测试设计也不够熟悉。因此计划必须把一切必要信息都写清楚,让执行者无需额外上下文即可按步骤完成任务。

主要能力

  • 生成完整的实现计划文档,覆盖每个任务需要触碰的文件、代码、测试、可能需要查阅的文档以及如何测试。
  • 将计划拆解为“微小任务”(bite-sized tasks),每个步骤只包含一个动作,耗时约 2-5 分钟。
  • 遵循 DRY、YAGNI、TDD 和频繁提交的工程原则。
  • 计划文档带有固定头部,包含目标(一句话说明要构建什么)、架构(2-3 句话说明方法)和技术栈(关键技术/库)。
  • 每个任务按统一结构组织,列出要创建、修改和测试的确切文件路径,并给出分步操作。

使用方式

开始时应声明:“I'm using the writing-plans skill to create the implementation plan.”

该技能应在专门的工作树(worktree)中运行,该工作树由 brainstorming 技能创建。

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

每个计划文档必须以如下头部开始:

[Feature Name] Implementation Plan

For Claude: REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.

Goal: [One sentence describing what this builds]

Architecture: [2-3 sentences about approach]

Tech Stack: [Key technologies/libraries]


任务结构示例:

Task N: [Component Name]

Files:

  • Create: exact/path/to/file.py
  • Modify: exact/path/to/existing.py:123-145
  • Test: tests/exact/path/to/test.py

Step 1: Write the failing test

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

Step 2: Run test to verify it fails

Run: pytest tests/path/test.py::test_name -v Expected: FAIL with "function not defined"

Step 3: Write minimal implementation

def function(input):
    return expected

Step 4: Run test to verify it passes

Run: pytest tests/path/test.py::test_name -v Expected: PASS

Step 5: Commit

git add tests/path/test.py src/path/file.py git commit -m "feat: add specific feature"

适用场景

  • 设计阶段已完成,需要把设计转化为可执行的实现任务。
  • 需要让不熟悉代码库的工程师(或子代理)按计划独立完成任务。
  • 希望以 TDD 方式推进开发,并保持频繁提交。
  • 需要为后续执行阶段(executing-plans 或 subagent-driven-development)准备输入。

限制与注意事项

  • 计划中必须始终使用确切文件路径,不能只写“添加校验”这类模糊描述。
  • 计划中必须包含完整代码,而不是笼统的说明。
  • 必须给出确切命令及其预期输出。
  • 需用 @ 语法引用相关技能。
  • 保存计划后,需向用户提供两种执行选择:
    1. 子代理驱动(当前会话):每个任务派发新的子代理,任务之间进行审查,快速迭代。若选择此项,必需子技能为 superpowers:subagent-driven-development,并留在当前会话。
    2. 并行会话(独立):在新会话中使用 executing-plans,带检查点批量执行。若选择此项,需引导用户在工作树中打开新会话,新会话必需子技能为 superpowers:executing-plans。
  • 关于该技能的收费、价格、平台支持范围等具体信息,资料中暂未提供。