Проверяемость
Каждое утверждение в отчёте связано с тем, чем оно проверено. «Сделал» без «чем проверил» — это мнение.
Пример отчёта
Самое частое беспокойство перед началом работ — «я не пойму, что мне сделали». Поэтому результат всегда оформляется документом. Ниже — обезличенный образец: настоящая структура, вымышленный заказчик.
Отчёт по работам: стабилизация сервера
Что просили
Сервер периодически переставал отвечать, причину найти не могли.
Что нашёл
Три причины, из них одна главная. Фоновая задача выполнялась дольше, чем интервал её запуска, и очередь наслаивалась сама на себя. Две сопутствующие: отсутствие лимитов на журналы и автозапуск, не переживающий перезагрузку.
Что сделал
Развёл расписание и добавил защиту от наложения запусков. Поставил лимиты и рабочую ротацию журналов. Починил автозапуск и проверил его перезагрузкой в согласованное окно.
Чем проверил
Сутки наблюдения после изменений: пропусков задач нет, время выполнения в норме, свободное место стабильно. Перезагрузка: все сервисы поднялись сами.
Чего НЕ делал
Не трогал код приложения и не менял версию базы. Обе темы всплыли по дороге, но выходили за рамки согласованных работ.
Что осталось
Резервные копии делаются, но их восстановление ни разу не проверялось. Это отдельная задача, и она важнее остальных хвостов.
Как откатить
Прежние файлы настроек сохранены рядом с новыми, команда возврата приведена. Проверено, что откат работает.
Отчёт остаётся у заказчика вместе с доступами и настройками. Ничего не остаётся «только в голове исполнителя».
Почему так
Отчёт — это не бюрократия
Независимость
Через полгода вы или другой инженер поймёте, почему сделано именно так. Это снимает привязку ко мне.
Честность
Раздел «чего не делал» и раздел «что осталось» есть всегда. Работа без хвостов бывает только в рекламе.
Хотите такой же по вашей инфраструктуре? Начинается всё с разбора задачи.