关于 grill-with-docs
面向文档工作的技能,通过一次一个问题来澄清计划、术语和决策。它会先检查现有项目背景与文档,再提问或建议新增文件。
主要功能
- 01每次提出一个聚焦问题
- 02检查现有项目文档
- 03梳理假设与权衡
- 04术语明确后更新背景文档
- 05有选择地创建 ADR
适用场景
- 01开始实施前澄清计划
- 02统一项目特定术语
- 03判断决策是否需要 ADR
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ wilbeibi/ wilbeibi-skills --skill grill-with-docs安装后在 Claude Code 中输入/grill-with-docs确认已加载。
附带文件ADR-FORMAT.mdCONTEXT-FORMAT.md
详细介绍
grill-with-docs
每次只向用户提一个问题,直到计划、术语和重要决策清晰到足以采取行动。
工作流
- 阅读用户的计划、链接文档、代码或相关本地文件,以了解主题。
- 在提议新增文档前,查找现有的
CONTEXT.md、CONTEXT-MAP.md和docs/adr/文件。 - 每次只提一个有针对性的问题。等待用户回答后再继续。
- 如果可以从代码库或现有文档中找到答案,就检查它们,而不是提问。
- 对每个问题,都给出你推荐的答案或可能的权衡,让用户可以接受、拒绝或完善。
- 深入探究模糊的词语、隐藏的假设、边缘情况、决策之间的依赖关系以及可逆性。
- 术语确定后,立即更新适当的
CONTEXT.md。 - 只有对于难以逆转、缺少背景时会令人意外且确实存在权衡的决策,才提出编写 ADR。
文档规则
CONTEXT.md是项目专用术语及其关系的映射表,不是规范或临时记录。- 仅当代码库存在多个有界上下文时才使用
CONTEXT-MAP.md。 - 按需创建文档:在内容真正确定前,不要添加
CONTEXT.md或docs/adr/。 - 文档应保持简洁,确保后续 Agent 愿意阅读。
术语表格式请参阅 CONTEXT-FORMAT.md。 ADR 格式和标准请参阅 ADR-FORMAT.md。
问题模式
- “怎样的结果能说明这项更改成功了?”
- “哪个现有概念负责管理此行为?”
- “什么是能证明该设计可行的最小场景?”
- “如果这个假设不成立,会有什么问题?”
- “未来的维护者可能会想改回什么?”
- “哪个术语应作为规范用语,哪些别名应避免使用?”
评论
支持 Markdown