ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

grill-with-docs 完整指南:如何在一次会话里把对齐结论沉淀成仓库文件

grill-with-docs 完整指南:如何在一次会话里把对齐结论沉淀成仓库文件 grill-with-docs 完整指南如何在一次会话里把对齐结论沉淀成仓库文件【免费下载链接】skillsSkills for Real Engineers. Straight from my .agents directory.项目地址: https://gitcode.com/GitHub_Trending/skills13/skills你和 Agent 花半小时对齐好的设计结论关掉会话就消失了——上下文窗口被重置下一轮对话里对方又是陌生人。grill-with-docs就是为了解决这个问题它围绕你的计划或设计进行一轮轮提问同时把敲定的术语写进CONTEXT.md领域文档、把关键决策写成 ADR 架构决策记录文件让共识在会话结束后依然留在磁盘上。为什么是边问边写机制先讲透先看它的入口文件 skills/engineering/grill-with-docs/SKILL.md正文只有一行Call the Skill tool twice, for grilling and domain-modeling.也就是说它本身不干活而是把工作拆给两个底层技能grillingskills/productivity/grilling/SKILL.md负责问。把设计建模成一棵树每个决策下面挂着依赖它的新决策整场访谈就是沿着这棵树逐层展开domain-modelingskills/engineering/domain-modeling/SKILL.md负责写。挑战含糊的用词、用边界场景逼你说清概念边界、对照代码验证你的说法并在术语与决策结晶的瞬间立刻落盘。这条委托链带来两个必须记住的特性只能手动触发。元数据里disable-model-invocation: true对应 agents/openai.yaml 的allow_implicit_invocation: false意味着 Agent 不会自己调用它你必须输入/grill-with-docs启动。单独装它等于没装。如果grilling和domain-modeling不在场Agent 拿到这行指令只能靠猜你会得到一场没有推荐、没有落盘纪律的盲问。访谈的具体节奏由 grilling 定义它只问前提已全部敲定的那批问题原文称之为前沿一轮内把整批问题编号问完每题附上推荐答案然后停下等你的回复你的回答会解封下一批依赖问题如此往复。有两条例外容易忽略需要查文件系统才能回答的事实Agent 会派子代理自己去查不问你也不阻塞整轮——只有下游依赖这个问题的才等结果而所有决策必须摆到你面前由你拍板。当没有任何问题可问时会话自然结束。跑一次会发生什么完整流程把它当成一次可照做的流程走确认前提。你处在某个代码仓库里、且写文件是安全的它真的会写。落盘位置术语进仓库根目录的CONTEXT.md若根目录有CONTEXT-MAP.md说明是多上下文仓库则写入对应上下文的CONTEXT.md决策进docs/adr/。这些文件全部懒创建——第一个术语敲定前磁盘上一个文件都不会出现。启动会话。输入/grill-with-docs然后用一两句话说清你要对齐的计划或者干脆说帮我给这个仓库补领域文档见下文场景 4。按轮次回答。Agent 会按下面的格式提问你只需逐条回答或直接采纳推荐❓ **Q1** - **问题标题**: 问题正文可以是多段包含多个选项 ➡️ 你的推荐答案 --- ❓ **Q2** - **问题标题**: 问题正文可以是多段包含多个选项 ➡️ 你的推荐答案产出三类东西且地位完全不同解决了什么落在哪里写入时机项目自己的一套叫法术语CONTEXT.md术语表敲定那一刻内联追加过三关的决策详见下一节docs/adr/下编号 ADR通过三道门槛时其余所有讨论仅存在于这段对话里不落盘第三行是新手最容易误判的地方术语表变锋利了、ADR 却为零属于完全正常的结局。ADR 门槛极高下一节细讲多数决策根本不够格。收尾。问题问尽、你确认双方理解一致后把这段对话原封不动交给to-spec合成规格见末节不要直接清空上下文。落盘格式速查两份规范一次看懂CONTEXT.md 术语表怎么写格式定义在 skills/engineering/domain-modeling/CONTEXT-FORMAT.md标准结构长这样# {上下文名称} {一两句话描述这个上下文是什么、为什么存在。} ## Language **Order**: {对该术语一两句话的描述} _Avoid_: Purchase, transaction **Invoice**: A request for payment sent to a customer after delivery. _Avoid_: Bill, payment request **Customer**: A person or organization that places orders. _Avoid_: Client, buyer, account四条书写规则值得记住有主见同一概念有多个候选词时选定最好的一个其余写进_Avoid_行定义要短最多一两句写它是什么不写它干什么只收本项目的专属概念超时、错误类型这类通用编程词汇哪怕你天天在用也不入表自然聚簇才分组术语天然分成几类时加子标题否则平铺即可。单上下文仓库绝大多数只有根目录一个CONTEXT.md多上下文仓库则在根目录放CONTEXT-MAP.md列出各上下文的位置与相互关系比如Ordering 发出OrderPlaced事件Fulfillment 消费它开始拣货。技能会自行判断属于哪种结构都不存在时就等第一个术语敲定再懒创建根CONTEXT.md。ADR 三道门槛逐条看skills/engineering/domain-modeling/ADR-FORMAT.md 规定只有以下三条同时成立才值得开一份 ADR难以回退——以后改主意的代价实打实地高没有上下文会让人困惑——未来的读者看到代码会问他们干嘛要这么做是真实权衡的产物——确实存在其他选项你出于具体理由选了其中一个。任何一条不满足就跳过。因此大多数会话产出 0 份 ADR这属于设计使然而非故障。够格写入的通常是这几类架构形态如写模型用事件溯源读模型投影到 Postgres上下文之间的集成方式如Ordering 与 Billing 走领域事件不走同步 HTTP带锁定效应的选型数据库、消息总线、认证提供方这类换掉要花一个季度的组件边界与范围决策包括明确的不做如Customer 数据归 Customer 上下文所有其余上下文只按 ID 引用对显而易见路径的刻意偏离如我们用手写 SQL 而非 ORM因为 X防止后人好心修复代码里看不见的约束合规限制、合作方 API 的响应时间契约等被否掉且理由不明显的替代方案否则半年后一定有人重新提一遍。ADR 模板与编号规则模板精简到只有一段# {决策的短标题} {1-3 句话背景是什么、我们决定了什么、为什么。}文件放在docs/adr/下按顺序编号0001-slug.md、0002-slug.md依此类推。编号方法扫一遍现存文件取最大编号加一。可选章节Status frontmatter、Considered Options、Consequences只在真正提供额外信息时才加。docs/adr/目录同样是懒创建第一份 ADR 需要时才出现。别在错的地方用它五个场景判断这个技能定位为单会话工具选不选它取决于你手边是什么不在任何工作目录里只想把脑子里的想法捋顺 → 用grill-me同样是逐轮提问但不涉及仓库与文件有一个仓库改动一次会话内能敲定→ 就是grill-with-docs的主场工程量大到一次会话装不下绿地项目、巨型功能→ 用wayfinder它先把工作画成一张决策票据地图再逐张解决节奏更慢更密对范围清晰的功能它是过度武器。两者并不互斥——wayfinder 可以就地图中某一部分下探进一次 grilling 会话仓库没有任何领域文档你也没在想某个具体功能→ 照样用grill-with-docs把目标对准仓库本身说帮我给这个仓库补文档。社区常见的搭配是配合improve-codebase-architecture来构建或修复CONTEXT.md。注意你要掌舵它会读代码并基于发现追问而代码里已有的哪个词才算对只有你能定决策卡在别人脑子里的知识上→ 用to-questionnaire把问题整理成问卷异步发给那个人。一句话记忆grill-with-docs与wayfinder的分界线就是会话数量单会话用它多会话用它。排错与验收先逐项对照再下结论出问题时先对症状大部分故障其实是配置或预期偏差⚠️跑完了但既没生成CONTEXT.md也没有 ADR。两种原因。良性的一种没有东西够格——ADR 要三关全过一场没有新词汇的会话本就无物可写。真正的 bug 是当它运行在另一层编排规格驱动开发包装器、多 Agent 框架、把它当作流水线某一步的规则内部时写文件那一半会被静默跳过访谈却照常进行。该问题已登记、尚未修复。处于这种配置时先检查你的工作目录再决定是否信任会话输出。⚠️它一口气把所有问题全问了、没有推荐、全程没提CONTEXT.md。这是两个依赖技能没加载成功的典型症状——因为入口只是一行委托Agent 只能凭猜测理解grilling。更迷惑的是半加载grilling在、domain-modeling不在你会得到一场体面的访谈却拿不到任何落盘产物。怀疑时直接问 Agent你加载了哪些技能⚠️精确结论顺序保证、否定性需求、数值默认值在下游变味了。因为术语表不是规格、多数回答也挣不到 ADR目前唯一能靠的缓解办法是保留整段会话直接喂给to-spec并拿你自己的回答逐条核对生成的规格别默认它捕获了一切。✅ 它工作正常的判定标准五条全中才算数CONTEXT.md在会话进行过程中逐词增长而不是结尾一次性冒出术语表读起来是纯词汇——你项目的词加紧凑定义没有实现细节或规格式散文代码库自己能回答的问题由读代码回答而不是拿来问你你拿到很少甚至零份 ADR且拿到的每一份都是重新辩一遍会很烦的决策它会因为你刚用的词与既有术语表定义冲突而当场挑战你。上下游衔接与依赖技能安装清单grill-with-docs站在主构建链的最前端grill-with-docs → to-spec → to-tickets → implement → code-review。它先于任何规格存在产出的是共享理解和已敲定的词汇to-spec 拿到这段对话后不再二次访谈直接合成规格并发布到问题跟踪器。所以会话结束后的标准动作是在同一对话里调to-spec若改动小到可以立即动手则直接进implement。拿不准该走哪条流程时ask-matt技能负责路由。依赖技能安装清单三选一路线装完都要确认这三个技能在场grilling、domain-modeling、setup-matt-pocock-skillsClaude Code 路线claude plugins install mattpocock-skills或在会话内执行/plugin install mattpocock-skills随后在每个仓库运行一次/setup-matt-pocock-skills完成配置它会问你用哪个问题跟踪器、triage 标签词表、文档保存位置Codex 及其他 Agent 路线npx skillslatest add mattpocock/skills安装器会列出全部技能让你勾选——务必勾上上述三个否则grill-with-docs只是一行空壳想直接拿源码改的话也可以git clone https://gitcode.com/GitHub_Trending/skills13/skills后自行维护。安装就绪后在仓库里敲下/grill-with-docs让设计树逐轮长全、让术语在敲定的瞬间落进CONTEXT.md、让过三关的决策成为docs/adr/里一份带编号的记录——然后带着这些仓库里的资产把会话原样交给to-spec进入构建链的下一环。【免费下载链接】skillsSkills for Real Engineers. Straight from my .agents directory.项目地址: https://gitcode.com/GitHub_Trending/skills13/skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表