关于 grill-me-with-docs
用于访谈领域术语、系统边界和文档决策的技能,面向需要维护项目文档的开发者与 Agent。它结合代码核查,并在讨论过程中更新术语表和系统地图。
主要功能
- 01逐次追问并探索决策分支
- 02维护领域术语表 LANGUAGE.md
- 03维护系统地图 MAP.md
- 04识别值得记录的架构决策
- 05创建新接口前检查现有实现
适用场景
- 01澄清项目术语并即时记录
- 02梳理组件位置与系统连接
- 03评估新增模块或 CLI 命令是否重复
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ rjminsha/ skills --skill grill-me-with-docs安装后在 Claude Code 中输入/grill-me-with-docs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
DECISIONS.mdLANGUAGE-FORMAT.mdMAP-FORMAT.mdREFERENCE.md详细介绍
使用 grill-me 技能开展访谈,重点关注领域术语、系统边界和文档决策。如果 grill-me 不可用,请根据 REFERENCE.md 中的备用说明直接开展访谈。
已使用的技能
| 技能 | 如果不可用 |
|---|---|
grill-me | 直接访谈用户:一次只问一个刨根问底的问题,逐步梳理决策树的每个分支,为每个问题提供推荐答案,并在代码库可以回答问题时进行查阅 |
领域认知
此技能用于创建和维护三份持续更新的文档:
| 文件 | 用途 |
|---|---|
LANGUAGE.md | 规范领域术语——说明事物的含义。仅包含术语表,不包含实现细节。 |
MAP.md | 简明系统地图——说明事物的位置及其关联方式。为上下文有限的 Agent 和开发者提供整个系统的参考。 |
docs/decisions/ | 记录难以逆转、出人意料或确有取舍的决策。 |
文件结构
/
├── LANGUAGE.md ← domain glossary
├── MAP.md ← system map
├── docs/
│ └── decisions/
│ └── 0001-*.md
└── src/
按需创建文件——只有需要记录内容时才创建。多上下文结构请参阅 REFERENCE.md。
会话期间
根据 LANGUAGE.md 校验术语,明确含糊的表述,讨论具体场景,并对照代码交叉核实说法。详细的会话行为请参阅 REFERENCE.md。
在会话中更新 LANGUAGE.md
术语确定后,立即更新 LANGUAGE.md。不要攒到最后再更新——应在讨论过程中及时记录。请使用 LANGUAGE-FORMAT.md 中的格式。
LANGUAGE.md 仅作为术语表,不包含其他内容——没有实现细节,也不记录决策。
验证新接口
创建任何新组件、模块、UI、API 接口或 CLI 命令之前:
- 检查
MAP.md中是否已有等效项 - 检查代码库中是否已有等效项
- 如果存在,请询问:“这看起来已经以 X 的形式存在——创建新的是否有意为之?”
- 如果确认要创建,请询问它与现有项相比新增了什么功能,然后更新
MAP.md
请使用 MAP-FORMAT.md 中的格式。
在会话中更新 MAP.md
发生以下任一情况时,立即更新 MAP.md:
- 确认或识别出新的组件、UI 或相关系统
- 验证发现
MAP.md中有条目需要修正 - 会话结束时——检查
MAP.md,确认是否有讨论过但尚未记录的内容
谨慎提出决策记录
只有在决策难以逆转、缺少背景时会令人意外,而且确实存在取舍时,才提出记录决策。完整标准和格式请参阅 DECISIONS.md。
会话结束时
打印最终文件结构,列出所有新建或更新的文件:
/
├── LANGUAGE.md ← updated
├── MAP.md ← updated
├── docs/
│ └── decisions/
│ └── 0001-example-decision.md ← created
└── src/
评论
支持 Markdown