Recording Decisions

作者 riekelt85e53729dd95无许可证28 个星标收录于 2026年10月8日更新于 2026年10月8日仓库3周前更新

Use when a decision needs recording - an ADR, a decision log entry, or when someone asks to write down why something was chosen, rejected, or superseded. Encodes the ADR and decision-log formats. Use whenever a choice was made that would otherwise live only in chat, even if nobody says "ADR".

AI 生成的概览

以 ADR 或轻量决策日志条目记录决策,涵盖背景、理由与后果。

功能
该技能规定了两种记录决策的格式:用于架构级决策的完整 Nygard 式 ADR,以及用于较小、连续决策的轻量决策日志条目。它说明了需要填写的部分,例如背景、决策、后果、考虑过的替代方案和参考资料,并产出仅可追加的书面记录。它还定义了取代旧条目、将相对日期转为绝对日期,以及明确记录负面结果与未知事项的规则。
适用场景
当某项选择已经做出并需要记录时,当有人询问为何选择、否决或取代了某个方案时,或当某项决策只在聊天或 PR 评论中一闪而过时使用。它不适用于仍在争论中的决策,那属于设计文档流程。
运行要求
仅为说明性内容,不附带脚本。其中提到需要具备技术写作技能作为背景。

Recording decisions

REQUIRED BACKGROUND: the technical-writing skill (hard rules, truth rules, style).

Overview

Two formats, by weight: a full ADR for a decision with architecture-level consequences; a decision log entry for the running stream of smaller choices. Both are append-only: an accepted decision is immutable; new context is a new entry that supersedes the old one.

When to invoke, and not

Invoke when a choice has been made and needs recording, when someone asks "write down why we did this", or when an existing decision is superseded. Do NOT invoke for a decision still being argued (that is writing-design-docs; its Why & What box becomes the ADR once accepted).

Also invoke on the signals that an unrecorded decision is passing by: "we decided X instead of Y", "let's just go with", a trade-off resolved in a PR comment or chat thread, or a rationale someone has now explained twice. Each is a decision living in a non-durable place; offer to record it.

Record the decision before citing it. A chat session is not a durable source. Put the dated substance in the log, quote the decider where wording matters, commit the entry, then cite it. Record the smallest complete decision, not a transcript.

ADR

Nygard format. One decision per ADR.

markdown
# ADR-[number]: [short title of the decision]
| | ||---|---|| **Status** | Proposed / Accepted / Superseded by ADR-XXX || **Date** | YYYY-MM-DD || **Deciders** | [who took part] |
## Context[The forces at play: technical, organizational, political. What must be solved.Factual, without giving away the decision.]
## Decision[What was decided. Active voice: "We release on tags", not "it was decided that".]
## Consequences**Positive:** [what gets easier]**Negative:** [what gets harder, which trade we accept]**Neutral:** [what changes without being better or worse]
## Alternatives considered**[Alternative]** - For: [...] Against: [...] Why not chosen: [...]
## References[Evidence, related decisions, measurements]

Negative is mandatory and may not be empty. Each alternative carries its strongest argument for; a rejection without it is a strawman.

The sole permitted edit to an accepted ADR is its Status line gaining "Superseded by ADR-XXX". An objection raised but never answered goes in at full strength as a negative consequence with a named owner: the writer never invents a rebuttal and never withholds a decision its owner has declared. Names unknown at writing time are marked fill-before-filing, because a filed record carries real people.

Decision log (lightweight)

For the running log a full ADR would kill. Cheap enough to maintain:

markdown
## YYYY-MM-DD
### [Decision stated as an imperative sentence][One paragraph: the rule.]Why:- [reason]- [reason]Instead of: [rejected option] - [why not]

Rules

  • Append-only. A wrong entry gets a new dated entry that supersedes it, never an edit. Convert relative dates to absolute.
  • Record the why, not only the what.
  • When a written rule and shipped reality have diverged, record which one the team intended. Every doctrine document states what it owns and what it leaves to others.
  • Scope guard at the top when a sibling could overlap: "product ideas live in ROADMAP.md; this file is for engineering decisions."
  • Capture negative results and unknowns explicitly: "four theories, four disproved, cause not found" is a result. A search returning nothing is a result.

来源与署名

来源:riekelt/technical-writer位于plugins/technical-writer/skills/recording-decisions提交85e5372

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架