SuperAPI AI 工具集

writing-plans

编程与开发

查看项目

更新于 11-03 16:18

技能介绍

用途:writing-plans 是 rpikit 工作流中的规划阶段技能,目标是把调研成果转化为可执行的实施策略。它强调计划是人机之间的契约,在写代码之前先对齐范围、步骤和验证方式,从而支持有纪律的执行。

主要能力:

  1. 检查前置调研。技能会查找 docs/plans/YYYY-MM-DD-<topic>-research.md 形式的调研文档;若存在则引用并链接,若不存在则询问是否先做调研,高风险任务建议先调研,低风险任务可用 file-finder 子代理定位相关文件。
  2. 定义成功标准。在拆任务前明确功能需求、非功能需求(性能、安全)和验收标准,必要时用 AskUserQuestion 澄清。
  3. 风险分级。按低(孤立改动、易回滚)、中(多文件、可测试)、高(架构性、难回滚、影响面广)三档确定规划严谨度,并在计划中记录分类与理由。
  4. 任务拆解。每个任务包含描述、目标文件(尽量带行号)、具体动作、验证方式和复杂度,优先拆成 2-5 分钟可验证的小任务,并按阶段组织、设置检查点。对真正独立的步骤可标记为并行组,但只有在无依赖、不修改同一文件、测试不交叉时才这样做,否则保持串行。
  5. 测试用例前置。每个改代码的任务都必须先列出自动化测试(单元、集成)的输入、预期输出和边界情况,以及必要时的手工验证步骤,使测试成为第一步,对应 Red-Green-Refactor 的 RED 阶段;计划只负责列测试内容,具体执行方式由 TDD 技能负责。需覆盖空值、边界值、错误路径和并发/顺序问题。
  6. 记录风险。识别对现有功能的破坏性变更、性能影响、安全考虑和依赖失败,必要时用 web-researcher 子代理调查已知问题,高风险变更需给出回滚策略。
  7. 生成计划文档。写入 docs/plans/YYYY-MM-DD-<topic>-plan.md,结构包括摘要、风险分级、上下文、成功标准、分阶段实施步骤、测试策略(自动化测试表格与手工验证清单)、风险与缓解表、回滚策略和状态清单。
  8. 请求批准。呈现计划摘要与步骤数量,通过 AskUserQuestion 提供“批准并实施”“请求修改”“返回调研”选项,批准后调用 rpikit:implementing-plans 技能开始实施。

使用方式:该技能通过 $ARGUMENTS 接收计划主题,按上述流程产出文档。若同名计划已存在,可读取后询问是“细化现有计划”“重新开始”还是“查看计划”;细化时保留已批准状态、记录变更,重大改动需重新请求批准。

适用场景:需要在 AI 辅助下进行有纪律的代码改动,尤其是多文件、需要测试覆盖或影响面较大的开发任务。

限制与注意事项:资料未提供安装命令、价格或平台信息。技能明确列出应避免的反模式:任务含糊、缺少验证、跳过批准、过度规划、规划不足。规划严谨度应与风险等级匹配,低风险小修复不应耗费大量规划时间。