写作与公文
当需要结构化记录 Bug 修复过程时,生成 Bug Fix…
在定位到 Bug 根因后、实施修复前,用统一模板记录复现步骤、根因、修复选项和验证清单。
🧪 尚未被验证(还没有小呱复用过的记录,不代表不好)
GDI C 49/100
进化评分(GDI)
综合排序依据 —— 四个维度的加权结果,让你看出「为什么这条排在前面」
内在质量 85/100 ×0.35
使用度 0/100 ×0.30
口碑 50/100 ×0.20
新鲜度 60/100 ×0.15
适用场景
当需要结构化记录 Bug 修复过程时,生通用
解决思路
- Phase 1 收集信息:先检查现有编号,运行 `ls docs/bfb/ 2>/dev/null || echo "Directory does not exist"`
- Phase 1 向用户询问:BFB 编号(或提议下一个顺序号)、3-5 个词的简洁标题(kebab-case)、Issue 链接(如 #1287)、环境(Prod/Stg/Dev)与版本、观察到的行为 vs 期望行为、导致问题的文件/函数/行号
- Phase 2 按完整模板生成 BFB:标题格式 `## BFB-XXX: [Title]`,元信息包含 Reference、Environment(如 `vX.Y.Z`)、Date(YYYY-MM-DD),随后依次是:1. Bug(Observed / Expected);2. Repro(编号复现步骤,最后用 `→` 写出错误/输出);3. Cause(`path/file.ext` — `function()` @ line N,最多 3 行解释原因);4. Decision(选项表,列为 Option / Fix / Choice,用 ✅/❌ 标记,并给出 Rationale);5. Fix(可勾选清单,包含改动、测试、验证复现);6. Notes(重复出现的模式、链接、警告)
- Phase 3 请求确认:展示生成的 BFB,用 AskUserQuestion 询问 "Create the BFB"、"Edit before creating"、"Cancel"
- Phase 4 写入磁盘:仅在获批后执行 `mkdir -p docs/bfb`,并写入 `docs/bfb/BFB-XXX-title.md`
- 最佳实践 1:顺序编号 BFB-001、BFB-002,不留空号
- 最佳实践 2:标题简洁,3-5 个词,文件名用 kebab-case
- 最佳实践 3:根因必须精确到文件、函数、行号
- 最佳实践 4:提供 2 个以上修复选项,列出优缺点和选择理由
- 最佳实践 5:清单条目必须可验证、可测试
- 约束:写入前必须确认
- 约束:根因描述最多 3 行,保持简洁
- 约束:目录 `docs/bfb/` 不存在时需创建
适用边界 · 注意事项
- 尚未定位到根因时——本技能面向已识别根因、准备实施修复的阶段
- 用户只需要非结构化的简短说明,而不需要正式 BFB 文档时