SuperAPI AI 工具集

workflows-plan

编程与开发

查看项目

更新于 11-12 22:25

技能介绍

用途

workflows-plan 用于把功能描述、缺陷报告或改进想法整理成结构清晰、符合项目约定的 Markdown 项目计划文件。技能明确要求:仅做研究与撰写计划,不编写代码(NEVER CODE)。

主要能力

  1. 仓库研究与上下文收集:并行启动三个子代理,分别分析代码库中的既有模式、相似实现与项目约定;检索与功能相关的行业最佳实践;查找相关框架/库文档。要求记录具体文件路径(如 app/services/example_service.rb:42)、外部文档 URL、相似 issue 或 PR,并记录 AGENTS.md 或团队文档中的约定。
  2. Issue 规划与结构:拟定可搜索的规范标题(如 feat:、fix:、docs:),确定类型(enhancement、bug、refactor),分析受影响的相关方与实现复杂度,规划所需章节与支撑材料(错误日志、截图、设计稿、复现步骤)。
  3. SpecFlow 分析:在结构规划后启动子代理校验与完善功能规格,检查完整性与缺口、边界情况与潜在问题,并据此更新验收标准。
  4. 实现详细程度三档可选:MINIMAL(快速 Issue,适合简单缺陷与小改进,含问题描述、基本验收标准、必要上下文);MORE(标准 Issue,适合多数功能与复杂缺陷,增加背景动机、技术考量、成功指标、依赖与风险、基本实现建议);A LOT(综合 Issue,适合大型功能与架构变更,增加分阶段实现计划、备选方案、详细技术规格、资源与时间线、未来扩展、风险缓解与文档计划)。
  5. 内容格式化与交叉引用:使用清晰的标题层级、带语言高亮的代码块、任务列表、可折叠日志,并按类型使用表情符号(🐛、✨、📚、♻️);关联 issue/PR、提交 SHA、永久链接与外部资源;考虑 AI 协作开发背景,记录研究中使用有效的提示词与 AI 工具,强调充分测试与需人工审查的 AI 生成代码。
  6. 最终审查与提交:检查标题可搜索、标签准确、模板章节完整、链接有效、验收标准可度量;在伪代码示例与待办列表中写明文件名;涉及新模型变更时补充 ERD mermaid 图。

使用方式

若未提供功能描述,技能会先询问“What would you like to plan?”,在获得清晰描述前不继续。计划输出到 plans/<issue_title>.md。生成后提供选项:在编辑器中打开、加深计划(并行研究最佳实践、性能、UI 等以增强各章节)、评审计划(参考 @guidance/reviewers/)、开始实现(参考 @workflows-work 技能)、创建 Issue、简化。简化后会询问要简化什么并重新生成,并循环回到选项,直到进入实现或评审。

创建 Issue 时从 AGENTS.md 检测项目跟踪器(project_tracker: github 或 project_tracker: linear):GitHub 使用 gh issue create --title "feat: [Plan Title]" --body-file plans/<issue_title>.md;Linear 使用 linear issue create --title "[Plan Title]" --description "$(cat plans/<issue_title>.md)"。若未配置则询问使用哪种跟踪器,并建议在 AGENTS.md 中添加配置;创建后显示 issue URL,并询问是否继续实现或评审。

适用场景

适用于新功能规划、缺陷修复规划、重构与改进想法的梳理,以及需要团队协作评审、创建跟踪 Issue 并衔接后续实现流程的研发场景。

限制

该技能不执行编码,只研究与写计划;详细程度默认“越简单越好”。资料未提供其运行平台、安装方式、收费模式或效果保证。