SuperAPI AI 工具集

bug-fix-brief

办公与效率

查看项目

更新于 10-15 21:52

技能介绍

用途:该技能生成 Bug Fix Brief(BFB),在 docs/bfb/ 目录下以统一结构记录每次缺陷修复,包含根因、复现步骤、修复方案选项与修复清单。触发词包括“create BFB”“document bug”“bug fix brief”“document fix”。适用时机为用户要求创建 BFB、希望以结构化方式记录缺陷修复,或在已定位根因、尚未实施修复之前。

主要能力与流程:

  1. 收集信息:先检查现有编号并列出目录,命令为 ls docs/bfb/ 2>/dev/null || echo "Directory does not exist";随后询问 BFB 编号(或提出下一个序号)、简短标题(3-5 个词,kebab-case)、问题链接(如 #1287)、环境(Prod/Stg/Dev)与版本、观察到的行为与预期行为、根因所在文件/函数/行号。
  2. 生成模板:按完整 BFB 模板填写,含标题、引用、环境与版本、日期,以及 Bug(Observed/Expected)、Repro、Cause、Decision(修复方案对比表与理由)、Fix(可验证清单)、Notes 六个部分。
  3. 确认:通过 AskUserQuestion 提供“Create the BFB”“Edit before creating”“Cancel”三个选项。
  4. 落盘:仅在确认后执行 mkdir -p docs/bfb,并写入 docs/bfb/BFB-XXX-title.md。

最佳实践:编号连续无空缺(BFB-001、BFB-002);标题简洁且文件名用 kebab-case;根因需精确到文件、函数、行;至少提供 2 个修复方案并附优缺点与理由;清单项必须可测试。

限制与注意事项:写入前必须始终获得确认;根因描述最多 3 行;目录不存在时需创建。其余细节资料暂未提供。