SuperAPI AI 工具集

grill-with-docs

写作与研究

查看项目

更新于 10-16 04:06

技能介绍

用途

grill-with-docs 是一个面向方案评审与领域建模的 AI 技能。它的核心目标是通过持续追问,让用户与 AI 就一个计划达成共识,同时把讨论中澄清的领域术语和关键决策沉淀为文档。

主要能力

  • 持续追问:围绕计划的各个方面反复提问,沿着设计树的每个分支逐层推进,逐个解决决策之间的依赖关系。
  • 提供推荐答案:对每个问题给出推荐答案,帮助用户更快做出判断。
  • 逐个提问:一次只问一个问题,等待用户反馈后再继续。
  • 优先探索代码库:如果某个问题可以通过探索代码库回答,则改为探索代码库,而不是直接提问。
  • 领域感知:在探索代码库时,同时查找现有文档,包括 CONTEXT.md、CONTEXT-MAP.md 以及 docs/adr/ 下的 ADR 文件。
  • 术语挑战:当用户使用的术语与 CONTEXT.md 中已有语言冲突时,立即指出并请用户确认。
  • 模糊语言锐化:当用户使用含糊或含义过载的术语时,提出精确的规范术语建议。
  • 具体场景压力测试:围绕领域关系构造具体场景,尤其是边界情况,迫使用户明确概念之间的边界。
  • 与代码交叉验证:当用户描述某件事如何工作时,检查代码是否一致;若发现矛盾则提出来。
  • 即时更新 CONTEXT.md:术语一旦确定就立即更新 CONTEXT.md,不批量处理,使用 CONTEXT-FORMAT.md 中的格式。
  • 谨慎提供 ADR:仅当难以逆转、缺乏上下文会令人困惑、且属于真实权衡这三个条件同时满足时,才建议创建 ADR,使用 ADR-FORMAT.md 中的格式。

使用方式

该技能以对话方式运行。用户提出一个计划后,技能会逐个提问并等待反馈。在探索代码库时,它会同时查找文档结构:

  • 大多数仓库只有一个上下文,结构为根目录下的 CONTEXT.md、docs/adr/ 和 src/。
  • 如果根目录存在 CONTEXT-MAP.md,则仓库有多个上下文,该映射文件指向每个上下文所在位置,例如 src/ordering/ 和 src/billing/ 各自拥有 CONTEXT.md 与 docs/adr/。

文件按需创建:只有在有内容可写时才创建。如果不存在 CONTEXT.md,则在第一个术语确定时创建;如果不存在 docs/adr/,则在需要第一个 ADR 时创建。

CONTEXT.md 不应与实现细节耦合,只包含对领域专家有意义的术语。

适用场景

  • 在开始实现前评审一个设计方案或计划。
  • 澄清领域术语,统一团队语言。
  • 梳理设计决策之间的依赖关系。
  • 将讨论中形成的领域共识沉淀为 CONTEXT.md。
  • 在满足条件时为关键决策记录 ADR。

限制

  • 关于收费、价格、平台支持情况、具体效果等信息,资料中暂未提供。
  • ADR 的创建有严格条件,不满足三个条件时不应创建。
  • CONTEXT.md 只应包含对领域专家有意义的术语,不应包含实现细节。