adr
An architecture decision record: context, the decision, its consequences and status, with links to the records it supersedes or is superseded by.
- License 许可
- MIT
- 最近更新
- 2026-11-14
- Stars
- ★ 1.1k
- Forks
- 104
01 前言 Front Matter
- od
- { "mode": "prototype", "craft": { "requires": [ "typography", "typography-hierarchy", "color", "accessibility-baseline" ] }, "preview": { "type": "html", "entry": "index.html" }, "platform": "desktop", "scenario": "engineering", "design_system": { "requires": false }, "example_prompt": "Write an ADR for the decision to lay diagrams out in the browser with CSS grid instead of a graph-layout library: context, decision, options considered, consequences and status." }
- name
- adr
- tags
- [ "adr", "architecture decision", "decision record", "engineering", "架构决策" ]
- emoji
- 🧭
- en_name
- ADR
- zh_name
- 架构决策记录 ADR
- category
- doc
- scenario
- engineering
- triggers
- [ "adr", "architecture decision record", "decision record", "record this decision", "架构决策" ]
- description
- An architecture decision record: context, the decision, its consequences and status, with links to the records it supersedes or is superseded by.
- en_description
- An architecture decision record: context, the decision, its consequences and status, with links to the records it supersedes or is superseded by.
02 资源文件 1
- 其他.od-local-overlay82 B
03 SKILL.md 正文
ADR
Intent. A short, permanent record of one decision, read months later by someone asking why the system is the way it is. One decision per record.
Ground it
Write only what the sources say. Gather them yourself before writing a word:
- the code that embodies the decision, and the discussion behind it (issues, PRs, design docs the user names);
- existing ADRs in the repo (
docs/adr/,docs/decisions/,adr/): match their numbering and find the ones this supersedes.
Keep the list of files, commits and refs you read: they go in a Sources section at the bottom of the page and in sources when you register (register_open_design_artifact with kind html). If something the document needs isn't in the sources, ask the user, or mark it plainly as an open question. Never invent numbers, dates, names or quotes.
Structure
- Header:
ADR-<NNNN>: <the decision as a short statement>, date, deciders if known, and a status banner<p class="status" data-od-status="proposed|accepted|deprecated|superseded">…</p>. If it supersedes or is superseded by another ADR, link both ways (Supersedes ADR-0003,Superseded by ADR-0012). - Context: the forces at play: constraints, requirements, what was tried. Neutral and factual.
- Decision: one paragraph in the active voice: "We will …".
- Options considered: a compact table: option, pros, cons, and why it lost or won.
- Consequences: positive, negative and neutral, as three short lists. Be honest about the costs.
- Sources.
Keep it to one or two screens. An ADR isn't a design doc.
Design
- One readable column (
max-width720–780px), body 16–17px with line-height 1.55–1.65, generous space between sections. It must read well on a phone: tables sit in anoverflow-x: autowrapper, nothing has a fixed width wider than the screen. - Style from the active design system (
--bg,--surface,--fg,--muted,--border,--accent); status colours are the only extra colours (green for accepted/done, amber for proposed/in progress, red for rejected/high severity, grey for superseded). - Headings are short labels; the content does the talking. Code, paths and commands in a monospace face, with
overflow-wrap: anywhereso long paths wrap on phones. - Finish with
check_open_design_artifactand fix every error at desktop and mobile width.
04 同仓库更多 Skills
youtube-clipper
YouTube clip generation and editing with automated workflows — pull source video, slice highlights, add captions, and export.
writing-guidelines
Review docs/prose for Writing Guidelines compliance. Use when asked to "review my docs", "check writing style", "audit prose", "review docs voice and tone", or "check this page against the writing handbook".
wpds
WordPress Design System. Apply WordPress's official design tokens, typography, and component patterns to themes and sites.
weread-year-in-review-video-template
WeRead-inspired HyperFrames video template for vertical annual reading reports, personal reading dashboards, book-note recaps, and shareable year-in-review stories. Use when users want a 9:16 HTML-to-MP4 reading report with warm paper texture, editorial Chinese typography, book-page metaphors, data highlights, and deterministic motion.
web-design-guidelines
Review UI code for Web Interface Guidelines compliance by the Vercel engineering team. Covers layout, typography, color, motion, and accessibility for product UI.
web-clone
网站复刻 / 克隆方法论。USE WHEN 用户说 复刻网站、克隆网站、clone website、抄个站、仿站、 照着这个站做一个、reproduce site、还原某个网页效果、把这个站搬下来改成我的、 复刻某个交互/WebGL/Canvas/Three.js 效果。提供「先拿真源码 → 判路径 → 逆向拆解 → 搭工程 → 替换内容」的可移植决策树,覆盖静态站 / React-Vue-Next 内容站 / WebGL-Canvas 重前端站三大分支,并强制核对任何 AI 二手分析里的可执行代码。