Екатерина Павлова пишет:

Gramax Community

Технические писатели (не)нужны

Увидела классный анонс в канале технического писателя (https://setka.ru/communities/018ea088-1459-408f-b6c6-120946f996f2) и вспомнила холиварный поинт: «Технические писатели не нужны. Их наличие в компании означает то, что сотрудники на других позициях не справляются со своими обязанностями».

Да, не нужны, но нужны. Сейчас разверну.

😡 Не нужны

Любая документация — результат работы над проектом или продуктом. Перед стартом всегда готовится проектная документация: проблема, варианты решения этой проблемы, техническое задание. По ней уже формируются задачи в разработку.

В идеальной картине мира задача в разработку = пользовательский сценарий. И из этого пользовательского сценария можно формировать итоговую документацию и инструкции.

Значит перед релизом аналитик может взять всю доку и просто немного ее подкорректировать.

🥶 Но нужны

Только аналитик не будет этого делать. А кто будет?

Юлия Ранн

· 10.04

Мы живем без технических писателей и имеем хорошую документацию. На предыдущем моем проекте было так же. Добиваемся этого тем, что разработчики не только пишут код, но и проектируют архитектуру своего продукта. То есть доку пишут архитекторы или те, кто в данный момент в шапке архитектора

Екатерина Павлова

· 12.04

Это крутой уровень организации и ответственности! Респект🙏

Александр Анисин

· 10.04

Если разработчик/аналитик/инженер может хорошо (!) описать то, что он сделал — да, можно обойтись без технического писателя. Вот только картинка обычно шире и сервис состоит из нескольких систем.

У разработчиков есть свои задачи: написать код, развернуть сервис, следить за инфраструктурой. Добавить им в этот список документацию, конечно, можно, но нужно ли?

Бизнес не может бесконечно ждать. А time to market всё-таки очень важен. Технические писатели во всем разберутся и помогут внутренним командам, если н них есть вопросы по продуктам.

Как ни как доку пишем — почти все знаем 🫠