Что это и для кого

Что такое техническая документация, как и где её писать будет полезно знать:

• техписателям, только начинающим свой путь;
• руководителям, которые чувствуют, что в их команде есть проблемы с документацией;
• разработчикам, если они не понимают, зачем вообще нужна документация.

Но курс в первую очередь для техписателей, потому что это люди, которые занимаются только документацией.

Что такое «технический писатель»

Технический писатель (техписатель, техрайтер) — человек, который управляет знаниями. Это могут быть и инструкции для внешних пользователей продукта, и внутренние архитектурные документы, и документации API — что из этого когда становится нужным разберём в рамках курса.

Типичный день техписателя наполнен встречами с людьми, у которых есть некоторое знание и это знание надо куда-то переложить. В продуктовых компаниях типичный цикл работы техписа выглядит так:

Каждый этап разберём подробно в следующих частях.

Чем техпис отличается от других текстоделов

В первую очередь — приставкой “технический”. Значительная часть техписателей умеет в и должна уметь в техническую часть своего проекта. Так проще выстроить диалог с разработчиками, а иногда и заметить свежим взглядом какие-то проблемы в архитектуре приложения.

Как стать техническим писателем

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

Ключевой навык — всё-таки любовь к текстам и струк. Если гуманитарий захочет научиться кодить, то с бОльшей вероятностью у него это займёт меньше ресурсов, чем обучение технаря русскому языку и основам редактуры. Конечно же есть такие истории успеха, но чаще всего ценные техписы — это разработчики, которые всегда увлекались текстами и осознали своё истинное призвание 🙂