Как правильно писать отчёт об ошибках

Автор Тема: Как правильно писать отчёт об ошибках  (Прочитано 6110 раз)

Оффлайн Александр_

  • С авторитетом
  • *****
  • Сообщений: 3330
    Ты ставишь чайник на плиту, включаешь над ней подсветку, чтобы увидеть, что вкусненького в соседней сковородке приготовил тебе муж, а света-то и нет.
    Как ты ему об этом скажешь?
    «Дорогой, поменяй лампочку на кухне» или «Любимый, там эта штука не светит»?
    В этот момент любимый сосредоточенно изучает что-то новое-интересное и ему твоя лампочка — до лампочки.
    Как сказать ему о подсветке?
    Точнее, давай так себя спросим: как ему сказать о подсветке таким образом, чтобы он услышал, обратил внимание и однозначно понял, в чем состоит проблема?

    Это называется «баг репорт» (bug report), сообщение о дефекте. Это понятие пришло из области разработки программного обеспечения, но оно касается человеческого общения в целом. Не то, чтобы это было очень уж важной частью нашей жизни, но для работы полезно знать, как обращать внимание людей и коллег на проблемы. Более того, ведь мы не ставим себе целью просто обратить внимание на проблему, на сам факт ее существования. Нам важно, чтобы наш собеседник понял, в чем именно ее суть и чтобы на фоне его сознания сразу же закрутился поиск решения. Невнятный багрепорт («там эта штука не светит») все равно придется уточнять до внятного. Но на это уйдет время и дополнительные уточнения («какая штука? А почему ты считаешь что она должна светить?»), получить которые без нервов не получится. А нервы надо беречь.

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

Формула совершенного багрепорта

    Формула совершенного багрепорта состоит из трех простых пунктов:

    1. Что сделала?
    2. Что получила?
    3. Что ожидала получить?


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

    Пример: «Дорогой, я включила свет над плитой, чтобы посмотреть, что вкусного ты приготовил, а он не горит. Ты не мог бы посмотреть, в чем там дело?»

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

    А также:
  • Где получила. Эта информация должна присутствовать в багрепорте, чтобы тот, кто будет его читать, сразу понял, в какой части системы случилась беда. Необязательно эту информацию давать отдельным пунктом. Можно просто включить ее в «что сделала», поскольку путешествие по системе к сломавшейся детали — это действия.
  • Условия. То, что не является действием, но что важно. Например, для интернет-приложений можно упомянуть название браузера, в котором вы работаете.
  • Название. Это самое краткое описание проблемы или ее части, какое только можно сформулировать. Используется для устного общения, для списков багрепортов и т.п.

    Это — очень полезная форма отчёта:
  • Она прозрачна. Она не позволяет репортеру отклониться в повествовательный стиль или транслировать поток сознания;
  • По ней сложно написать что-то, отличное от багрепорта. Как следствие, уменьшается количество информационного шума в работе;
  • Легко проверить. То есть, выполнив указанные шаги, можно получить такой же результат и подтвердить что дефект существует; или же получить иной результат и создать новый багрепорт; или же получить ожидаемый результат и отклонить багрепорт;
  • В таком багрепорте четко видно, действителен ли он, то есть, действительно ли данная ситуация является дефектом. Вдруг так и надо, чтобы лампочка над плитой не горела, потому что ее там вовсе не предусмотрено, а холостой выключатель по непонятным соображениям поставили загадочные китайцы?
  • Такая форма избавляет от лишней коммуникации (донельзя надоевших общих уточняющих вопросов);
  • Этой форме легко обучить несмышленных пользователей; Всего два-три дня истерик и ваши коллеги научатся внятно общаться;  :bk:
  • Сообщая вам в багрепорте, что именно ожидал увидеть пользователь, он тем самым как бы подтверждает, что он владеет системой и понимает, как она должна работать в данном случае;
  • Такой багрепорт не мотивирует ответственное лицо заткнуть его в угол подальше и забыть поскорее .
Делай добро и бросай его в воду. (с)

Оффлайн Женя

  • Модераторы
  • *****
  • Сообщений: 5752
  • г. Челябинск
- дорогая, где у нас чай?
- в банке из под кофе, на которой написано сахар...

Оффлайн Владислав

  • С авторитетом
  • *****
  • Сообщений: 30895
  • ГАВ!
...баночка стоит в ванной, за бутылочкой, на которой написано "уксус"...
Грехи людей пересчитать вы так усердно рвётесь.
Начните со своих.. и до чужих вы вряд ли доберётесь..