Управление временных решений
Регистрирует обходные пути, которые используются дольше системы, для которой их придумали.
Срок временности продлевается автоматически, пока существует хотя бы один человек, опасающийся удалить строку.
структура учреждения
Состав инспекции
Отдел осторожных переименований
Меняет названия переменных только после письменного подтверждения от всех неизвестных потребителей.
Переменная data2 сохранена. Более точное название могло бы создать ложное ощущение понимания.
Архив первоначальных причин
Ищет, зачем условие было добавлено, и выдаёт наиболее правдоподобную версию вместо утраченной.
Причина обнаружена в переписке: «иначе падает». Дополнительные сведения отсутствуют.
Бюро продления временности
Подтверждает, что замена временного модуля требует ещё одного подготовительного периода.
Период продлён до завершения миграции. Миграция ожидает окончания подготовительного периода.
оперативная проверка
Экспертиза подозрительного фрагмента
Выберите улику из репозитория. Инспекция определит допустимую глубину вмешательства.
Улика не выбрана. Код считается понятным до первого открытия файла.
Порядок безопасного изменения
§1
Сначала прочитать историю
Изучить коммиты вокруг строки, не доверяя сообщению «мелкая правка».
Мелкая правка затронула 47 файлов. Автор хотел вернуть форматирование и случайно исправил продакшен.
§2
Зафиксировать текущее странное поведение
Написать тест на то, что система делает сейчас, даже если никто не заказывал именно это.
После фиксации странность становится контрактом. Это неприятно, но измеримо.
§3
Изменить одну вещь
Не совмещать исправление ошибки с переездом каталогов и улучшением названий.
Желание улучшить всё сразу заносится в отдельную задачу и теряется там безопасным образом.
§4
Проверить единственный сервер
Повторить изменение на машине, где локаль, время и библиотека шрифтов отличаются от остальных.
Если ошибка не повторилась, это не означает успех. Возможно, сервер заметил проверку.
§5
Оставить объяснение
Написать комментарий о причине решения, а не пересказать соседнюю строку другими словами.
Фраза «увеличиваем счётчик на один» описывает действие. Причина снова ушла в архив.
Стоимость инженерной уверенности
День небольшого исправления
- 09:20
Ошибка воспроизведена локально только после смены даты и языка системы.
- 10:45
Найдено условие, добавленное без описания восемь лет назад.
- 13:10
Подготовлена правка в две строки и тест в сорок семь строк.
- 16:35
Сборка прошла. На единственном сервере исчезла кнопка печати.
- 18:12
Правка отложена. Добавлен комментарий, почему к этому месту следует вернуться осторожно.
Заключения специалистов
«Удалил одну проверку, которую считал лишней. Узнал о трёх клиентах, двух интеграциях и празднике в другой стране.»
«Документации не было, зато имена переменных складывались в тревожный, но последовательный рассказ.»
«Мы переписали модуль с нуля и получили ту же ошибку. Теперь она хотя бы покрыта тестом.»
Вопросы перед изменением
Почему этот код никто не переписал＋
Его переписывали дважды. Обе версии обращаются к нему за редкими исключениями.
Можно удалить закомментированный блок＋
Можно после проверки документа, где он указан как резервный способ расчёта.
Кто автор функции＋
Система контроля версий указывает на человека, который переносил файл и никогда не видел функцию целиком.
Почему тест проверяет ошибку＋
Потому что внешний потребитель отличает ответы именно по этой ошибке.
Когда временное решение станет постоянным＋
Оно уже стало. Постоянное решение пока проходит оценку рисков.
изменение допускается
Сделайте код понятнее, не лишая его привычной странности
Инспекция разрешает одну аккуратную правку при наличии теста, объяснения и рабочего способа всё вернуть.