5 типов инженеров, которых встречает технический писатель (и выживает)

Работа технического писателя — это вечеринка, где вы единственный, кто пришёл с документацией, а все остальные — с коммитами. За годы общения с инженерами я вывел пять архетипов, которые встречаются в любой команде. Готовьте попкорн: будет больно и смешно.

1. «Молчаливый гений» Этот парень пишет код, который работает как швейцарские часы, но на вопрос «Как это работает?» отвечает односложно или вообще мычит. Вытащить из него описание — всё равно что выудить Wi-Fi у бабушки: сигнал есть, но пароль никто не знает. Приходится читать его коммиты и надеяться, что он не использовал венгерскую нотацию.

2. «Энтузиаст-архитектор» Он обожает сложные термины и паттерны. Вместо «выполнить запрос» он скажет «инициировать асинхронный вызов через шину событий». Его документация похожа на инструкцию к IKEA, написанную на эльфийском. Но если перевести, там часто скрывается гениальное решение.

3. «Вечно занятой» У него 47 задач в JIRA, 5 открытых пулл-реквестов и встреча через 10 минут. На ваш вопрос он ответит: «Глянь в коде, там всё очевидно». Спойлер: не очевидно. Приходится ловить его у кофемашины и выпытывать ответ между глотками эспрессо.

4. «Перфекционист» Он исправит опечатку в комментарии, даже если это сломает CI. Его пулл-реквесты — произведение искусства, но их ревью длится дольше, чем ночной деплой. С ним документация будет идеальной, но выйдет к следующему десятилетию.

5. «Душа компании» Этот инженер знает все мемы, шутит про JavaScript-фреймворки и всегда готов помочь. Он — ваша палочка-выручалочка: объяснит сложное простыми словами и даже нарисует схему на салфетке. Единственный минус — его слишком много отвлекают, и код он пишет реже, чем шутки.

Комментарий студии METABYTE: Мы знаем все эти типы и даже парочку своих. Если вам нужна документация, которую поймут и джуниоры, и тимлиды — мы переведём с «инженерного» на человеческий. И да, кофе у нас тоже отличный.