SOLID English School Blog

Как написать отчет об инциденте/баг-репорт

Для начала быстро чекнем, что это такое.

Если ты уже работаешь в айти-команде, наверняка ты уже слышал о Incident report. Этот отчет описывает события, которые нарушили нормальную работу некоторых процессов, и как эта ситуэйшн была решена.

Почему важно писать эту документацию?

  • Анализ первопричины происшествия
  • Разработка изменений, чтобы предотвратить подобные ситуации в будущем
  • Выявление слабых мест приложения / продукта


🔥 Структура incident report:

  • Summary

В 5 предложениях описываем причины, продолжительность (включая часовой пояс), влияние на пользователей.

  • Timeline  (по тихоокеанскому времени)

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

  • Root cause

Это подробное описание причины инцидента. Важно указать как можно больше деталей.

  • Resolution and recovery

Описываем все действия, предпринятые разработчиками для разрешения инцидента (даже неэффективные), а также время, когда было предпринято каждое действие, и его результаты.

  • Corrective and preventive measures

Главное в этой части - ответить на 2 вопроса:
Какие способы мы можем использовать для предотвращения повторения этого?
Что мы можем сделать лучше в следующий раз?

📍 Полезные linking words для составления отчета:

In addition, → In addition, the internal monitoring systems permanently blocked on this call to the authentication library.
As a result, → As a result, we decided to restart servers gradually (at 7:19 PM), to avoid possible cascading failures from a wide scale restart.
Although →  Although we rely heavily on tests in our development workflow, we will test even changes related to database updates on the staging server prior to rolling them out on the production server.
Afterward, → Afterward, our team initiated the task to restore the production database
Apart from → Apart from automated scheduled backups, our team will introduce database backups before all major changes.

Как на счет разобраться с остальными тонкостями составления документации, грамматическими ошибками in writing и вопросами пунктуации?

Мы разработали для этого курс письменного английского - 10 уроков в записи и проверка домашки от нашей Насти Машталяр


IT ENGLISH
Made on
Tilda