SuperAPI AI 工具集

adr-review

写作与研究

查看项目

更新于 10-16 06:37

技能介绍

用途

adr-review 用于审阅并重写 ADR(架构决策记录)。它的核心视角是:假装自己是团队中一名不具备作者全部上下文的成员,以“新鲜的眼睛”阅读每份 ADR,找出文档中假设读者已知上下文、埋没决策、或携带对未来读者无意义的历史包袱的地方。无论处理单份 ADR 还是批量 ADR,该技能都适用;即使一次涉及多份,也应把每份 ADR 独立对待,逐份完成分析与重写。

主要能力

该技能围绕两类工作展开:

  1. 分析问题:找出文档中缺失的内容、被埋没的决策、临时性信息,以及对新读者而言不清楚的部分。
  2. 重写文档:按照推荐结构对每份文件进行端到端重写,以解决已识别的问题。

使用方式

技能被调用时的工作流如下:

  1. 阅读范围内的 ADR(一份或多份)。
  2. 先在聊天中写出分析,而不是直接静默重写。分析要具体,引用或指出所标记的部分;涉及多份 ADR 时,为每个分析块清晰标注对应的 ADR。
  3. 然后逐份端到端重写每个文件,使其符合推荐结构。

在动手修改任何文件之前,先列出发现的问题并加以解释。当范围内有多份 ADR 时,按 ADR 分组呈现分析,以便用户在重写落地前对每一份作出反馈。

一份好的 ADR 应具备的特征

  • 以一个清晰的、可落地的示例开头:在抽象推理开始之前,先给读者一个具体的东西来锚定理解。
  • 有强有力的叙事,逐步构建主题,全程解释清楚;不要压缩内容,让想法有展开的空间。
  • 决策先行:开头就说明正在决定什么,读者应在梳理推理过程之前就知道结论。
  • 以“考虑过的替代方案”结尾:把被否决的选项放在最后,避免读者被文档已判定无关的路径信息所拖累。

ADR 不应包含的内容

ADR 是长期存在的文档,不应包含:

  • 对 Linear 工单、GitHub issue 或其他工单跟踪系统的引用。
  • 产生该 ADR 的项目里程碑。
  • 系统在重构期间或之前经历过的、今后不会再出现的状态——临时名称、正在移除的已弃用包装器、“当前”限定词、“我们过去……”式的表述。

如果某段上下文只对亲历过该变更的人有意义,就删掉它,或把它改写为关于系统当前状态的事实。

适用场景

适用于需要审阅、清理和重写架构决策记录的场景,尤其是希望确保 ADR 对没有历史背景的未来读者仍然清晰可读时。可处理单份 ADR,也可批量处理多份 ADR。

限制

资料未提供关于收费、价格、平台支持范围、具体安装命令或效果保证的信息。