返回精选库
grill-with-docs·开发与工程

grill-with-docs 使用指南:边问清需求,边留下项目文档

本文目录

通过持续追问明确设计,同时把项目术语和重要取舍记录下来,方便下一轮开发继续使用。

安装与准备

在项目目录的终端执行以下命令,安装后在 Claude Code 中输入下方提示。这里选择项目内的可编辑文件安装。

命令
npx skills@latest add mattpocock/skills --skill grill-with-docs --skill grilling --skill domain-modeling --skill setup-matt-pocock-skills --agent claude-code

使用 Codex 时,把安装命令最后的 claude-code 换成 codex,对话里把 /grill-with-docs 换成 $grill-with-docs。如果使用完整的 Claude Code 插件,则选择 /mattpocock-skills:grill-with-docs,不要再重复安装文件版本。

该入口组合调用 grilling 和 domain-modeling,文件方式安装时三者都要选。准备项目仓库、现有 CONTEXT.md 和 ADR;工程项目首次使用可运行 setup-matt-pocock-skills 选择文档位置。

第一次使用

把下面的场景和路径替换成你的项目情况,在 Agent 对话里输入:

提示词
/grill-with-docs
我想给付费课程加团队购买。先讨论购买者、学习者、席位和退款规则;从最影响后续设计的问题问起,确定的术语及时记下来。

怎样推进任务

从影响面最大的决定开始

团队购买并不只是增加数量输入框。先回答谁付款、谁占用席位、席位能否转让,再讨论邀请邮件长什么样。若 Agent 一次提出多个问题,按编号回答;不知道的地方说明约束,让它给出建议供你选择。

边讨论边固定词义

明确“购买者”和“学习者”可以不同后,把定义写进 CONTEXT.md。后续出现“用户”这个含糊词时,应进一步确认指哪一种角色。这样规格说明、变量命名和测试场景才有共同的语言。

只记录值得解释的决定

决定退款后是否立即回收席位时,可能需要权衡账务、学习进度和客服处理。这样的长期取舍可以记录 ADR;颜色或临时截止日期通常无需写入架构决策。记录完成后继续问未解决的问题。

完成后检查什么

最后让 Agent 列出已确定规则、仍未解决的问题,以及本次修改的文档。确认团队购买的关键分支都能解释,再在同一对话中使用 to-spec 整理规格说明。

常见问题

装好了却提示找不到其他 Skill? 检查 grilling、domain-modeling 是否一起安装。

和 grill-me 有什么区别? 这里会随着讨论维护领域词汇与决策文档;只想讨论一个普通想法,可以使用 grill-me。

会直接开发吗? 访谈和记录完成后,需要另行提出实现任务。

开始前选对讨论尺度

手头没有仓库、只想谈一个产品想法时,用 grill-me 更轻;有仓库且这个改动能在一次会话里厘清,才适合 grill-with-docs。跨很多会话的大项目需要先拆出问题地图,不能期待一次问答解决所有范围。把当前代码、已有术语和真正需要人决定的事交给它:代码已经能回答的问题,应先让 Agent 查代码,不要反复问你。

文档不会在启动时凭空生成。第一个词义清楚时才出现或更新 CONTEXT.md,只有越过长期取舍门槛的决定才进入 ADR,因此一次会话没有 ADR 也可能是正常结果。但如果访谈中明明定下了术语,结束时 CONTEXT.md 毫无变化,就应检查配套的 domain-modeling 是否实际执行,以及文件写在了哪个目录。收尾时对照新词、未决问题和改动文件阅读;只拿到一段流畅总结并不代表可供下一轮开发继续使用。

用退货流程试一次“边问边记录”

现有商城若想支持部分退货,可以输入:“用 grill-with-docs 讨论一张订单的两件商品只退一件。先看现有订单状态与退款代码;询问需要我决定的库存回补、运费和优惠分摊。确定‘退货申请’与‘退款完成’的含义时更新 CONTEXT.md,只有难以撤回的规则才记 ADR。”这和空白产品头脑风暴不同,已有代码能回答的事实先查清。

一轮结束时,应能看到术语文件中的新定义,以及仍未决定的金额或状态规则。如果只得到聊天里的总结而文件没有变化,检查是否真的调用了配套 domain-modeling。若 ADR 里记录的只是“按钮叫提交”,可以删掉;真正值得留下的是以后更改会影响账务和客服解释的决定。

让文档跟着问答同步变化

有工程师把 grill-with-docs 用在已经有 ADR 或规格文档、但决定尚未说清的任务上:讨论一个分歧,就把结论写进相应文件,而不是等会话结束再凭记忆补记。另一个使用者在 OpenCode 中借它发现计划与现有代码矛盾,并同步更新 CONTEXT.md 和 ADR。你可以每回答几轮就查看 diff,确认改动记录的是已确定术语或重要取舍;未决定的问题应留在问题清单里。

你的首次任务进行得怎么样?

选择项通过网站统计帮助我们了解常见卡点。屏蔽统计可能导致无法送达;具体问题请通过邮件反馈。

参考来源

  1. grill-with-docs — SKILL.mdmattpocock
  2. mattpocock/skills — READMEmattpocock
  3. grill-with-docs 官方使用说明Matt Pocock
  4. How I use AI for software engineeringChris Etheridge
  5. I've been using Matt Pocock's grill-with-docs skill in opencodeAimal Shah
发现过期或有误的信息?告诉我们

继续发现

其他值得了解的技能。