agentleFS
Sign inStart free
YangFan-Code-StarYangFan-Code-Star/context-dev/.agents/skills/record-decision/SKILL.md

record-decision

Skill2 starsChanged 3 months agoMITView on GitHub

把一个有取舍的技术决策写成 ADR 存进 docs/decisions/。当用户说"记一下这个决定"、"写个 ADR"、"为什么选了 X"、"这个方案定下来了"，或刚刚在两个方案之间做出选择时使用。

10 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use verify and handoff.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Microsoft AzureSkill

    verify

    End-to-end app testing pipeline for browser-based web apps on cloud browsers via Azure Playwright Workspaces: verify the live app, author tests for working flows, heal failing tests, then re-run with video and produce one consolidated report. Three phases (app verification, test authoring, test healing) plus a scoped final sanity run; each phase emits a sub-report. Use when asked to "verify my app", "make sure my app works and has good test coverage", "do a full QA pass", "add tests where I'm missing coverage", "fix failing tests and add new ones", "smoke test before deploy", "QA my deployment", or any combined verify-and-test ask. Requires Azure CLI (`az login`) and a Playwright Workspace resource ID — bootstraps configs on first invocation. Browser-based web apps with Playwright only — not for unit/API tests, native mobile/desktop, load/perf, or full accessibility audits.

    Also in 3 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

记录架构决策

代码能表达"做了什么"，表达不了"为什么不用另一个方案"。缺了这部分，agent 会反复提议已经被否决过的东西，而你要一遍遍重新解释。

什么时候该写

  • 在两个及以上方案之间做了选择，且另一个方案也说得通
  • 引入或换掉一个核心依赖、框架、存储
  • 定下一个会扩散到很多文件的约定（金额怎么存、时间怎么表示、错误怎么传）
  • 明确否决了一个看起来很自然的做法

不该写的：没有取舍的选择（"用项目已有的 logger"）、随时可以改的局部实现、纯风格问题。

怎么写

  1. 找到 docs/decisions/ 里最大的编号，加一。文件名 NNNN-用短横线连接的标题.md，标题是结论不是议题——写「金额用整数最小单位存储」，不要写「关于金额存储的讨论」。
  2. 复制 docs/decisions/template.md，填写。
  3. 关键在**「其他方案」一节：把认真考虑过的方案写下来，以及放弃它的具体原因**。这一节是 ADR 全部价值所在，只写一句"性能不好"等于没写。
  4. 如果这个决策会影响日常写代码的方式，在 AGENTS.md 加一行指针，正文留在 ADR 里。

只增不改

决策变了不要改旧文件，写一份新的，然后在旧的顶部加一行：

> 已被 [ADR 0007](0007-xxx.md) 取代。

保留被推翻的记录，是为了让后来者知道"这条路走过了"，而不是重新走一遍。

写完检查

  • 标题是结论，不是议题
  • 「其他方案」里每个被放弃的选项都有具体理由
  • 没有写进真实密钥、生产数据或个人信息
  • 如果影响日常写法，AGENTS.md 里留了指针

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free