Writing Postmortems

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

Use when writing a postmortem, incident report, or root-cause analysis after an outage, a defect that reached users, a data issue, or a near miss - or when turning an incident channel, alert log, or war-room thread into a durable document. Encodes the blameless framing, the evidence-only timeline, contributing factors, and owned action items. Use whenever something broke and the write-up must outlive the incident.

AI 生成的概览

指导撰写无指责式事后复盘、事故报告和根因分析,包含基于证据的时间线与有归属的改进项。

功能
提供结构化骨架和规则,用于在故障、影响用户的缺陷、数据问题或未遂事件之后产出复盘文档。内容涵盖摘要、量化的影响、仅含证据的时间线、根因与促成因素、响应过程中的错误尝试、带负责人和验收标准的行动项以及签核。还规定了无指责的结构性表述、按组织分类法确定严重级别,以及一经评审即不可更改、新发现以带日期的补充形式记录等约定。
适用场景
适用于事故已解决或长期事故进入稳定节点之后,包括未遂事件和已影响用户的缺陷。不适用于事故仍在进行时、责任认定或面向相关方的状态汇报。
运行要求
仅为说明性内容,不含脚本。它引用其他技能(technical-writing、writing-issues、recording-decisions、writing-runbooks)以及核心技能中的 references/truth.md 文件,并需要能够访问告警、日志、提交记录和消息等证据。

Writing postmortems

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

Overview

Audience: the engineer who hits something similar in a year, not the people in the room. Core principle: facts from evidence, causes from mechanisms, lessons from both, and no names. Classification: historical; once reviewed it is immutable, and corrections are dated addenda.

When to invoke, and not

Invoke after an incident is resolved, or at a stable milestone of a long one. A defect that reached users and a near miss (a guard caught what review missed) earn the same write-up. Do NOT invoke during the live incident: the runbook governs that. Not for assigning accountability: a postmortem that needs a person's name to make sense is describing a process hole. Not for a status update to stakeholders, which is a report.

Skeleton

markdown
# [System]: [the failure, as its symptom, one line]
| | ||---|---|| **Incident date** | YYYY-MM-DD || **Duration** | detection to resolution || **Severity** | [per the org taxonomy, defined where used] || **Status** | Draft / Reviewed |
## Summary[User-visible impact with numbers, the root cause in one sentence, current state.The reader who stops here still knows what happened.]
## Impact[Who and what, quantified: requests failed, records affected, money or time lost.Estimates labeled as estimates; "no evidence of data loss" only if actually checked,and say what was checked.]
## Timeline[Timestamped entries, facts only, each traceable to evidence: an alert, a log line,a commit, a message. Interpretation lives in the sections below, never here.]
## Root cause and contributing factors[The mechanism, grounded in code and commits. Contributing factors as a list;"every component was correct and the defect lived between them" is a valid rootcause. Name which layer of checking missed it and which caught it.]
## Wrong turns during the response[The wrong first fix, the misleading signal followed, the theory that cost an hour.]
## Action items[Each with an owner and an acceptance check, filed as tracker issues and linked."Investigate X" without an owner is banned here as everywhere.]
## Sign-off[- YYYY-MM-DD <reviewer>: approved <scope>, one line per review event.]

Rules

  • Blameless means structural. Name the role, the gate, the dependency, the missing guard; never the person. Blaming a person stops at "be more careful"; blaming a structure produces an action item. This governs the narrative (timeline, causes, response); action-item ownership is assignment, not blame: a role in this document, an individual in the linked tracker issue.
  • The timeline is evidence, not narrative. Every entry traces to something checkable, timestamps from the systems rather than memory. Where memory is the only source, say so.
  • Wrong fixes are content. The fix that made sense and did not work belongs in the document with the reasoning that made it plausible; embarrassment is not a retention policy.
  • Severity comes from the org taxonomy, defined where used, not assumed. When no taxonomy exists, leave the field explicitly unassigned rather than inventing one.
  • Action items follow writing-issues: outcome, owner, acceptance check, filed and linked, never left as prose intentions in the postmortem. When filing is not possible from where you sit, mark each item [to file: <who files it>]; the postmortem stays Draft until the links exist.
  • Immutable once reviewed. New findings are dated addenda; a rewritten postmortem is a falsified record. The review itself goes in a sign-off line (see references/truth.md in the core skill).
  • Near misses use the same skeleton, with Impact describing what would have happened, labeled as the counterfactual it is.

The decision that often follows a postmortem (a new invariant, a policy change) is recorded via recording-decisions and linked, not embedded. Runbook updates the incident exposed go through writing-runbooks in the same change as the fix; documentation is part of done, not a follow-up ticket.

来源与署名

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

许可证: 无许可证

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

举报或申请下架