mcpField
G
grill-with-docs

grill-with-docs

github.com/c0nant开发366 次安装4 天前更新
代码仓库

关于 grill-with-docs

这项技能用于梳理功能决策,并在过程中编写领域文档。它更新 `GLOSSARY.md`,将关键权衡记录为 `docs/adr/` 中的 ADR;功能适合编写规格或任务后即停止。

主要功能

  1. 01通过 "grilling" 技能调用
  2. 02构建并完善项目术语表
  3. 03以 ADR 记录关键权衡
  4. 04仅编写指定文档

适用场景

  1. 01明确功能相关术语
  2. 02在功能设计中记录决策
  3. 03为编写规格或任务做好准备

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/c0nant/skills --skill grill-with-docs

安装后在 Claude Code 中输入/grill-with-docs确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

RESUMO.md
TRADUCAO.pt-BR.md
agents/
openai.yaml

详细介绍

调用 Skill 工具,并传入 "grilling"。随着决策逐渐明确,在项目的领域文档中直接补充和完善内容:在 GLOSSARY.md 中添加或精炼术语,并在 docs/adr/ 中记录影响重大的权衡决策,作为 ADR。

本次会话只能写入这些文档。主题是功能本身:它的作用、适用对象,以及背后的决策。撰写工作说明由其他人负责。to-spec 编写规格说明,to-tickets 编写任务单。当没有待探索的问题时,说明该功能已准备好交由其中一个工具处理,然后就此停止。

使用通俗易懂的语言。优先使用日常用语,而非专业术语;术语首次出现时,先写出全称;如果某个名称对用户来说可能毫无意义,就用一句话解释。

评论

支持 Markdown