Лучшая проверка вашего инженерного мастерства — это то, что происходит, когда вы отходите от дел. Если кому-то приходится писать вам «как это работает?» — вы провалились. Системы должны продолжать работать. Паплайны должны продолжать развёртываться. Дашборды должны продолжать обновляться.
Это самая осознанная часть моей инженерной практики: создавать для того, кто придёт после меня.
Проверка
Прежде чем считать любую систему «готовой», я задаю вопрос: «Сможет ли инженер среднего уровня, никогда не видевший этот код, эксплуатировать его, не связываясь со мной?»
Если ответ «нет» — я ещё не закончил. Код может работать, но он не завершён.
Как выглядит «эксплуатируемость»
1. README, отвечающий на первые 5 вопросов
Каждый новый инженер задаёт одни и те же 5 вопросов:
- Что это делает?
- Как запустить это локально?
- Как развернуть это?
- Где находятся логи?
- К кому обращаться, если что-то сломается?
