Шаблоны обновлений отчетов об ошибках

Обеспечьте согласованность действий инженеров и заинтересованных сторон с помощью шаблонов структурированных обновлений.

Обзор категорий шаблонов

Сообщение об инцидентах и ​​ошибках — это процесс с высокими ставками, высоким давлением и структурно повторяющийся процесс. Во время активного инцидента возможность отправить четкое и полное обновление менее чем за 30 секунд более ценно, чем идеально написанная проза, написанная пять минут спустя. Шаблоны отчетов об ошибках Lightning Assist и обновлений инцидентов предоставляют предварительно структурированные фрагменты для каждого этапа инцидента — сортировка, анализ первопричин, проверка после исправления — поэтому вы никогда не отправляете неполное обновление во время сбоя, и все заинтересованные стороны получают согласованную информацию на протяжении всего процесса.

Когда использовать эти шаблоны

Используйте шаблоны отчетов об ошибках и обновлений инцидентов для любой технической коммуникации, требующей структурированного обновления: первоначальная сортировка при первом выявлении ошибки или инцидента, анализ первопричин после устранения, проверка после исправления для подтверждения стабильности и сводки заинтересованных сторон, которые переводят технический статус на простой язык для нетехнической аудитории. Они также полезны для стандартизации описаний проблем GitHub, Jira или Linear, поэтому инженерные команды получают необходимый им контекст без постоянных разъяснений.

Примеры шаблонов в этой категории

  • Сортировка и первоначальное обновление с указанием того, что известно, текущего статуса расследования и примерного времени следующего обновления.
  • Сводка основных причин с указанием графика инцидентов, причин, примененных исправлений и мер по предотвращению.
  • Проверка после исправления, подтверждающая разрешение, статус мониторинга и любые последующие действия.

Примеры шаблонов на практике

Сортировка и первоначальное обновление

Первое обновление во время инцидента задает тон тому, как заинтересованные стороны воспринимают контроль ситуации вашей командой. Хорошо структурированное обновление сортировки охватывает четыре аспекта: какая система или функция затронуты, что на данный момент известно о проблеме, что команда активно делает для расследования или устранения последствий и когда будет отправлено следующее обновление. Создайте фрагмент для этого первоначального обновления с заполнителями для имени системы, номера заявки и расчетного времени прибытия для следующего обновления. Вставьте его в Slack, в свой канал инцидентов или в систему обработки заявок в момент начала сортировки — прежде чем вы поймете, что случилось. Последовательные первоначальные обновления уменьшают объем вопросов «что происходит?» сообщения, которые прерывают работу команды во время активных инцидентов.

**Triage – [#Ticket#]**
**System:** [#System#]
**Summary:** [what we know]
**Status:** Investigating.
**Next update:** [#X#] min.

Краткое описание первопричин

Хорошо написанный анализ первопричин служит двум целям: он замыкает цикл для заинтересованных сторон и создает документированную запись, на которую смогут ссылаться будущие дежурные инженеры. Наиболее полезный формат RCA охватывает пять элементов: характер инцидента и его влияние, временной график от первого сигнала до разрешения, первопричину с достаточной технической детализацией, чтобы можно было принять меры, что было сделано для ее устранения и какие превентивные действия будут предприняты, чтобы избежать повторения. Создайте фрагмент для этой структуры с заполнителями для идентификатора и даты заявки. Согласованный формат RCA позволяет сравнивать посмертные данные с течением времени и помогает выявить закономерности в том, какие типы сбоев повторяются, и именно здесь инвестиции в предотвращение окупаются.

**RCA – [#Ticket#]**
**Incident:** [brief]
**Root cause:** 
**Fix applied:** 
**Prevention:** 
**Date:** [#Date#]

Проверка после исправления

После развертывания исправления обновление разрешения замыкает цикл обмена информацией об инцидентах и ​​сообщает заинтересованным сторонам три вещи: инцидент разрешен, что было сделано для его устранения и какой мониторинг или последующее наблюдение осуществляется, чтобы они могли быть уверены, что он не повторится немедленно. Создайте фрагмент разрешения с заполнителями для имени системы, времени разрешения и продолжительности мониторинга. Будьте кратки: в большинстве случаев от одного до трех предложений. Обновление решения — это последнее сообщение об инциденте, которое видят заинтересованные стороны, поэтому тон должен быть уверенным и ясным. Если применимо, включите ссылку на полную версию RCA, чтобы любой, кому нужна более подробная информация, мог найти ее, не спрашивая.

**Resolved – [#System#]**
Fix deployed at [#Time#]. [One line on cause/fix.] Monitoring for [X] hours. Will update if anything changes.

С чего начать

Сначала создайте три основных фрагмента инцидента: расследование (система, статус, ожидаемое время следующего обновления), устранение (система, что было сделано, статус мониторинга) и анализ первопричин (сроки, причина, исправление, предотвращение). Назначайте очень короткие триггеры, которые легко набирать при стрессе — ;inc, ;resolved, ;rca. Протестируйте их во время следующего планового периода обслуживания или планового развертывания. Затем добавьте фрагменты запросов на информацию по устранению неполадок для наиболее распространенных типов проблем, чтобы поддержка могла развиваться быстрее.

Советы профессионалов

  • Используйте очень короткие триггеры для фрагментов инцидентов (;inc, ;res, ;rca), поскольку вы будете вводить их в стрессовом состоянии во время активных инцидентов, когда заинтересованные лица ждут.
  • Создавайте простые и технические версии каждого обновления статуса, чтобы вы могли отправлять нужный уровень детализации нужной аудитории, не переписывая ее во время инцидента.
  • Сделайте раздел предотвращения в вашем фрагменте RCA обязательным — это самая важная часть анализа, позволяющая реально снизить количество инцидентов в будущем.
  • Делитесь шаблонами инцидентов с поддержкой и ротацией вызовов, чтобы эскалация всегда включала полный контекст в правильном формате, независимо от того, кто обрабатывает заявку.

Используйте эти шаблоны в любом приложении

Создавайте многократно используемые фрагменты из этих примеров и запускайте их с помощью быстрого доступа, ярлыков триггеров или улучшений искусственного интеллекта.

Начать бесплатную пробную версию

Связанные страницы и сниппеты

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