Перейти к содержимому

Шаблоны

Листья карты описывают умения. Шаблон закрывает соседний вопрос: с чего начать документ, когда умение понадобилось на практике.

Шаблоны лежат в каталоге templates/ репозитория обычными markdown-файлами, вне сайта. Так их проще забрать: открой файл на GitHub, скопируй сырой текст кнопкой «Copy raw file» и правь под свой сервис. Состав секций в шаблоне не обязателен, это отправная точка.

У каждого шаблона названы листья, в которых документ разобран: какое решение за ним стоит, кто его ведёт и на чём обычно спотыкаются. Лист стоит прочитать раньше, чем заполнять шаблон.

  • SLO-документtemplates/slo-doc.md

    Что измеряется у одного сервиса, какая цель поставлена и кто за неё отвечает: SLI с явным знаменателем, окно, бюджет ошибок, исключения и порядок пересмотра.

    Разобран в листе: SLO Engineering

  • Error Budget Policytemplates/error-budget-policy.md

    Что команда делает при разном расходе бюджета ошибок: пороги и действия, условия заморозки релизов и выхода из неё, исключения, эскалация.

    Разобран в листьях: SLO / Budget Review, SLO Engineering, Error Budget Gating

  • Runbooktemplates/runbook.md

    Пошаговая реакция дежурного на один алерт: проверка за две минуты, митигация с откатом на каждое действие, эскалация, поиск причины после митигации.

    Разобран в листе: Runbooks

  • Процедура откатаtemplates/rollback-procedure.md

    Как откатывают релиз одного сервиса: условия числами, кто решает, что откатывается и чем, чего откат не возвращает, шаги и проверка.

    Разобран в листе: Progressive Delivery

  • Toil Logtemplates/toil-log.md

    Журнал ручной повторяющейся работы команды за период и сводка по нему: доля toil против бюджета, самые дорогие задачи, решения.

    Разобран в листе: Toil Tracking

  • Постмортемtemplates/incident-postmortem.md

    Документ разбора инцидента: хронология на фактах, факторы вклада вместо корневой причины, action items с владельцем, сроком и критерием готовности.

    Разобран в листе: Blameless Postmortem

  • ADRtemplates/adr.md

    Запись одного значимого технического решения: контекст с ограничениями и критериями, рассмотренные варианты, выбор и последствия с обеих сторон.

    Разобран в листе: Architecture Decision Records

  • Ежемесячный SRE Reviewtemplates/sre-review-monthly.md

    Повестка и протокол ежемесячного обзора всех операционных практик команды: от SLO и постмортемов до toil и дежурств, с таблицей решений в конце.

    Разобран в листьях: SLO / Budget Review, SRE Maturity Assessment

  • Capacity Plantemplates/capacity-plan.md

    Сколько ресурсов понадобится сервису на горизонте планирования и когда начать действовать: допущения, пороги насыщения, прогноз, сроки поставки, точки действия.

    Разобран в листе: Capacity Planning

  • Production Readiness Reviewtemplates/production-readiness-review.md

    Проверка готовности сервиса к продакшну и запись её результата: чек-лист по шести блокам, исключения с владельцем и сроком, решение.

    Разобран в листе: Production Readiness Review

  • Disaster Recovery Plantemplates/disaster-recovery-plan.md

    Как сервис восстанавливается после катастрофы: RTO и RPO с обоснованием, права решения, копии с датой проверки, сценарии и учения.

    Разобран в листьях: Backup & Restore, DR Policy & Stakeholders, Disaster Recovery

  • Оценка зрелости SREtemplates/sre-maturity-assessment.md

    Оценка практик SRE по шести областям на шкале от 0 до 5: уровень сейчас с доказательством, целевой уровень, план шагов и сравнение с прошлой оценкой.

    Разобран в листе: SRE Maturity Assessment

  • Сценарий Game Daytemplates/game-day-playbook.md

    Одна тренировка реакции на инцидент: что отрабатываем, сценарий, радиус поражения и условия остановки, хронология, находки и задачи.

    Разобран в листьях: Game Day / Chaos Drills, Chaos Engineering

  • Матрица RACItemplates/raci-matrix.md

    Кто за какое решение отвечает: кто делает, кто утверждает, с кем советуются и кого ставят в известность. Одна страница с проверкой на одну A в строке.

    Разобран в листьях: Stakeholder Management, DR Policy & Stakeholders

  • Политика управления инцидентамиtemplates/incident-management-policy.md

    Правила реакции команды на инцидент: шкала серьёзности в числах, реакция по уровню, роли, эскалация по таймеру, сводки и разбор после.

    Разобран в листьях: Incident Response, Severity Classification

  • Политика дежурствtemplates/on-call-policy.md

    Как устроено дежурство команды: ротация и покрытие, обязанности дежурного, компенсация и отдых, показатели здоровья дежурства с порогами.

    Разобран в листе: On-Call Rotation

В шапке каждого шаблона два списка: когда его применять и когда не применять. Без второго шаблон заполняют ради самого документа, и он превращается в карго-культ: форма есть, решения за ней нет.

Привязок к конкретным компаниям и внутренним процессам в шаблонах нет. Отдельной лицензии тоже нет: шаблоны распространяются под Apache 2.0, как весь репозиторий.