Вредные советы: почему не нужно писать документацию

В лучших традициях Григория Остера


Код сам себя объясняет

Переменная tmp_var_2 — временная переменная номер два. Функция doStuff() делает штуки. Что непонятного?

Через год вы забудете, что “XX” — VIP из Швейцарии, “YY” — проблемные дебиторы. Зато какой азарт отлаживать баг в 5 утра субботы!


Будьте незаменимым

Держите всё в голове. Только вы знаете, как работает критическая система.

«Как это работает?» — «Сложно, лучше я сам».

Пусть звонят в 11 вечера пятницы: «Система упала».

Заболеете на неделю — отличная демонстрация ценности.


Экономьте время

2 часа на документацию или на фичу? Фича!

Новый DevOps три дня разбирается и роняет прод раз в месяц — мелочи. Зато больше фич в резюме!


Документация устареет

Через полгода забудете, зачем функция с тремя вложенными циклами. Восстанавливать мотивы прошлого себя — как детектив.

Особенно когда сломается в проде, а вы не знаете что она делает.


У вас отличная память

Когда упадёт база: «Сначала остановить сервис А, потом Б, или наоборот?» — отличная тренировка памяти под стрессом.

Потеряете данные — зато какая история!


Пусть система говорит

Не документируйте архитектуру. Пусть изучают по логам!

Сломают критическую интеграцию — незабываемые выходные, восстанавливая всё.


Избегайте комментариев

Настоящий код не нуждается в объяснениях.

Следующий разработчик «улучшит» ваш код, убрав множитель 1.000001, всё сломается — отличный урок.

Вы восстановите, объясняя что коэффициент компенсирует баг в библиотеке 2.1.3.


Пароли в голове

Только вы знаете пароль от прода.

Уйдёте в отпуск — команда проведёт незабываемое время, взламывая собственные системы.

Нужна срочная смена из-за утечки, а вы только сели в самолёт — пусть админы учатся креативности. Вскрытие собственного сервера отлично развивает навыки.


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

Особенно генеральный директор оценит звонки среди ночи: «Всё сломалось, а Петя в отпуске на Мальдивах без связи».