postmortem-templates icon indicating copy to clipboard operation
postmortem-templates copied to clipboard

A collection of postmortem templates

Postmortem Templates

This is a collection of postmortem templates derived from various sources such as the Site Reliability Engineering book, The Practice of Cloud System Administration book and other online resources.

Template List

  • Template from Site Reliability Engineering book
  • Template from The Practice of Cloud System Administration book
  • Template from Google Developers Blog post
  • Template from Azure status history posts
  • Template from Michael Kehoe's blog post
  • Template from the Real-World SRE book
  • Template from Elastic Cloud incident report

Load templates automatically

It is possible to load the postmortem templates automatically without copy pasting from the files or manually writing the structure every time you want to author an incident report.

Vim

You can add the following line into your .vimrc file:

au BufNewFile postmortem-*.md 0r ~/postmortem-templates/templates/postmortem-template-srebook.md

Emacs

You can add the following line into your .emacs file:

(add-hook 'text-mode-hook (lambda () (when (and (string-prefix-p "postmortem-" (buffer-name)) (= (point-max) (point-min))) (insert-file-contents "~/postmortem-templates/templates/postmortem-template-srebook.md"))))

In both cases the filename pattern is postmortem-*. For example, if you create a file named postmortem-api-outage-2017-05-29.md it will load automatically the predefined template into that file. You can replace both the postmortem template and pattern to match your.

Examples

Postmortem resources