Skip to content

Latest commit

 

History

History
125 lines (83 loc) · 4.55 KB

File metadata and controls

125 lines (83 loc) · 4.55 KB

CodeBuddy 使用说明

这份文档讲的是 CodeBuddy + superpowers 怎么更顺手地用。

重点是让中文对话更稳定地命中对应 skill,同时让产出的计划、评审、总结默认用中文。

在 CodeBuddy 里,superpowers 是怎么工作的

  • 简单说:CodeBuddy 自己就很适合承载 skill 和中文输出规则,但并行任务还是要切干净再做。
  • 这句话的意思是:CodeBuddy 自己的 .codebuddy/skillsCODEBUDDY.md 和语言设置,很适合承载 skill 和中文输出规则,所以单 agent 工作流在这里接得比较自然。
  • 为什么这样:这类工具本身就有适合放 skill 和说明规则的位置,我们就优先借这些原生位置来接,而不是额外再造一套。
  • 但对多 agent / 并行类 skill,我们还是会保守一点,按“隔离工作面拆分 + 主线程整合”来理解。
  • 原因很简单:这样更容易看清每个并行任务改了什么、验证了什么,也更不容易互相覆盖。

先看这几条

  • 项目级安装优先使用 .codebuddy/skills 和项目根 CODEBUDDY.md
  • 对多代理 / 并行类 upstream skill,当前更适合按“隔离面拆分 + 主线程收口”来执行。
  • 如果你希望新文档文件直接用中文名,可以明确补一句“未指定文件名时用中文文档名”。
  • 写计划时不用固定写到某个目录;你如果指定了保存位置就按你的要求来,没指定时再沿用仓库现有文档习惯。

先记住 3 种触发方式

1. 自然中文说法

例如:

  • “先做需求分析和总体设计”
  • “先把这个需求拆成实施计划”
  • “这个改动先做代码审查”

2. 直接点名 skill

默认安装名带前缀 superpowers-,所以建议写完整名字:

  • superpowers-brainstorming
  • superpowers-writing-plans
  • superpowers-finishing-a-development-branch

3. 如果这个工具支持 slash / command 形式

也优先写完整名字:

  • /superpowers-writing-plans
  • /superpowers-finishing-a-development-branch

CodeBuddy 最适合怎么理解

  • CodeBuddy 的项目级 skill 结构和 CODEBUDDY.md 规则很适合中文触发和中文文档输出
  • 对多代理 / 并行类 skill,当前更适合按“隔离面拆分 + 主线程收口”理解

你可以把它理解成:

  • 单 agent 工作流,基本按上游原意用就行
  • 并行类 skill 也能用,但要先把任务切干净
  • 如果 CodeBuddy 自己已经有合适的 skill 承载方式,我们优先借它自带的位置,不额外造概念

常用工作流

flowchart LR
    A["需求分析 / 方案讨论<br/>brainstorming"] --> B["实施计划<br/>writing-plans"]
    B --> C["按计划实现<br/>executing-plans"]
    C --> D["代码评审<br/>requesting-code-review"]
    D --> E["收尾前验证<br/>verification-before-completion"]
    E --> F["开发分支收尾<br/>finishing-a-development-branch"]
Loading

启动工作流

这件事按 superpowers 工作流来。你先判断该用哪些 skill,再开始推进。

从零开始的新需求

我要做一个新功能。先不要直接写代码,先做需求澄清、方案对比和设计取舍,结论用中文输出。

写实施计划

方案已经定了,你直接把它拆成实施计划。保存位置如果我指定了就按我指定的来;没指定时按仓库现有文档习惯放,并明确告诉我计划文件是哪一份。步骤要落到具体文件和验证方式,中文输出。

按计划继续实现

按刚写好的那份计划继续实现,不要重新从 TODO 或任务清单改选范围。能拆成隔离工作面的部分再并行推进,但最后统一由主线程整合和验证。

Bug 排查

这个问题先系统排查根因,不要直接给修复方案。先收集证据、确认影响范围,再决定怎么改。

TDD 修复

这个 bug 用 TDD 修。先写失败测试,再做最小修复,最后确认是否需要重构。

请求代码审查

这批改动先做代码审查,重点检查行为回归、边界条件、缺失测试和实现是否偏离计划,结论用中文。

处理 Review 反馈

这里有一批 review 意见。先判断哪些成立、哪些需要补证据、哪些可以保留不同意见,再决定怎么改。

完成前验证

别急着说完成。先跑完验证,把通过项、失败项和剩余风险分开列出来,再决定是否可以收尾。

想改中文触发词