Зимняя IT-школа CompTech

Технические писатели

Задача
Технический писатель — важная часть команды разработки программного или другого обеспечения. Его задача — донести до целевой аудитории принцип и порядок работы с объектом. Часто эта роль закрепляется за разработчиком / тестировщиком, что не всегда является эффективным решением.

Собирая информацию о разрабатываемом продукте у всех участников проекта, технический писатель создает полноценную документацию, в которой отражаются все аспекты функционирования продукта. В задачи технического писателя входят как помощь аналитику, например, в написании технического задания, так и формулировка инструкций для команды разработки и / или конечного пользователя. Сюда же можно включить актуализацию уже существующей документации — если документация будет неактуальной, то ей не будут пользоваться.

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

Куратор
Юлия Сергеевна Борзилова
Старший технический писатель, TeamLead,
DocFactor (Documentat)
Что ты узнаешь?
Что представляют собой технические писатели.
Узнаешь о роли технического писателя в проектах разработки коммерческого ПО.
Какую документацию пишут технические писатели на проектах
В чём обычно пишут документацию. Какие инструменты используют технические писатели в работе.
Процесс разработки документации.
Попробуешь выполнить разработку документации, как в «боевых» проектах разработки ПО.
Как написать хорошую документацию на примере одного из проектов Зимней школы.
Тебя прикрепят к команде проекта, и ты будешь помогать коллегам, ведь разработать прототип и внедрить инновационное решение — это ещё не всё. Очень важно задокументировать процесс и описать, как всё работает.
Требуемые навыки
  • Желание объяснять, как работать с вещами любой сложности.
  • Быстрое погружение в предметную область.
  • Коммуникабельность.
  • Знакомство с любыми языками разметки (markdown, RST, asciidoc) или желание их изучить.
  • Работа с системами версионирования (GIT, SVN) или желание их изучить.