Технический писатель: чем занимается и как им стать

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

Технический писатель: чем занимается и как им стать
Содержание
  1. Технический писатель: кто это и чем он занимается
  2. Какие документы пишет технический писатель
  3. Обязанности технического писателя в рабочем процессе
  4. Навыки и знания, которые нужны
  5. Инструменты технического писателя
  6. Как стать техническим писателем без опыта
  7. Обучение: что выбрать
  8. Портфолио и первые резюме
  9. Типичные ошибки начинающих
  10. Частые вопросы

Технический писатель: кто это и чем он занимается

Человек в этой роли отвечает за то, что продукт можно понять и применять по документации. Он не обязательно создает идеи и не пишет код, но должен достаточно разбираться в предмете, чтобы задать правильные вопросы специалистам и проверить собственный текст.

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

Документацию пишут два основных типа писателей. Одни работают с ИТ-продуктами: справка в интерфейсе, статьи базы знаний, описание программного интерфейса. Другие оформляют проектную и эксплуатационную документацию по ГОСТ для заказчиков, в том числе государственных. О втором направлении подробнее написано в материале о видах технической документации.

Какие документы пишет технический писатель

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

ДокументДля когоЧто внутри
Руководство пользователяРядовые пользователи системыНазначение, вход, порядок работы, ошибки, ответы на вопросы
Руководство администратораСистемные администраторыУстановка, настройка, резервное копирование, права доступа
Техническое заданиеЗаказчик и разработчикиЦели, требования, стадии, порядок приемки
Программа и методика испытанийКомиссия, заказчикПроверки, критерии, порядок и оформление результатов
Справка и база знанийПользователи, служба поддержкиКороткие статьи, пошаговые сценарии, скриншоты
Описание программного интерфейсаРазработчики интеграцииМетоды, параметры, примеры запросов и ответов

Примеры оформления документов для информационных систем собраны в статьях о том, как написать руководство пользователя и техническое задание.

Обязанности технического писателя в рабочем процессе

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

Условная доска задач технического писателя: от сбора информации до выпуска документа.
Условная доска задач технического писателя: от сбора информации до выпуска документа.
  1. Сбор информации. Писатель общается с аналитиками, разработчиками и тестировщиками, изучает продукт, смотрит прототипы и пробует функции на тестовом стенде.
  2. Планирование. Определяется состав документов, аудитория каждого, структура разделов, сроки и ответственные за проверку.
  3. Написание. Текст готовится по шаблону, принятому в команде, или по стандарту: ЕСПД, ГОСТ 34, ЕСКД.
  4. Согласование. Специалисты проверяют точность описания, заказчик - соответствие требованиям. Писатель вносит правки и ведет историю изменений.
  5. Оформление. Подготавливаются титульные листы, листы утверждения, обозначения, ссылки, оглавление и приложения.
  6. Поддержка. После изменений продукта документ обновляется, а версии сопровождаются номером и датой.

Часть работы нужно ограничивать заранее. Если писателя просят одновременно вести проект, тестировать и писать код, документация обычно страдает первой. Роль нужно зафиксировать в плане проекта с понятными границами.

Профессия сочетает три составляющие: умение писать, понимание предмета и аккуратность с оформлением. Ни одну из них не заменить другой, но каждую можно подтянуть.

  • Ясный письменный язык. Короткие предложения, термины без вариаций, единый стиль по всему комплекту документов.
  • Умение задавать вопросы и выяснять, что нужно читателю, а не автору функции.
  • Базовое понимание того, как устроены программные системы: клиент и сервер, база данных, права доступа, сценарии пользователя.
  • Знание стандартов, если документы идут государственным заказчикам: ЕСПД, ГОСТ 34, ГОСТ 2.105, ГОСТ 7.32.
  • Работа с текстовым редактором и шаблонами, стилями, нумерацией, оглавлением, перекрестными ссылками.
  • Умение рисовать схемы и делать аккуратные скриншоты с пометками.
  • Внимательность: опечатка в номере стандарта или названии кнопки подрывает доверие ко всему документу.

Стандарты не нужно заучивать наизусть. Достаточно понимать, какая система за что отвечает и где найти нужный пункт. Различия систем разобраны в статье о том, чем отличаются ЕСПД и ЕСКД.

Инструменты технического писателя

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

ЗадачаЧем решается
Написание и оформление документовТекстовые редакторы с шаблонами, стилями и автоматической нумерацией
Совместная работа и согласованиеСистемы с комментариями и историей версий, вики для команды
Хранение текста вместе с кодомЛегкая разметка и системы контроля версий
Схемы и диаграммыРедакторы блок-схем и диаграмм, подготовка по ГОСТ 19.701-90
Скриншоты и инструкцииПрограммы для захвата экрана с подписями и стрелками
Учет задачТрекеры, где документ ставится в план наравне с разработкой

Оформление схем - отдельная тема. Если вам предстоит рисовать алгоритмы, изучите разбор блок-схем по ГОСТ 19.701-90: он покажет, какие фигуры используются и как их соединять.

Как стать техническим писателем без опыта

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

  1. Определитесь с направлением: ИТ-документация для пользователей или проектная документация по ГОСТ. От выбора зависят нужные стандарты и инструменты.
  2. Изучите основы. Прочитайте несколько стандартов целиком, например ГОСТ 19.201-78 Техническое задание, и посмотрите готовые шаблоны.
  3. Попробуйте задокументировать простое приложение, которым пользуетесь сами: напишите руководство пользователя с пошаговыми инструкциями.
  4. Соберите портфолио из двух-трех работ разного типа.
  5. Попросите обратную связь у практикующего писателя или у знакомого разработчика.
  6. Откликайтесь на вакансии начального уровня и на стажировки. Для первой работы подойдет роль помощника писателя или аналитика с обязанностями по документации.

Обучение: что выбрать

Специальной обязательной программы нет. Знания получают из нескольких источников, и лучше сочетать их. Работа с реальными документами учит больше всего.

  • Стандарты. Читайте тексты ГОСТ и сопоставляйте с готовыми документами. На сайте есть шаблоны для документов по ГОСТ 34 и документов по ГОСТ 19.
  • Курсы. Бывают общие по профессии и узкие, по конкретным инструментам. Перед записью спросите, что выпускники смогли сделать в конце курса.
  • Практика. Предложите свою помощь проекту с открытым кодом, где не хватает документации, или волонтерской команде.
  • Самообучение на материалах. Читайте документацию к хорошим продуктам и разбирайте, чем она удобна.

Портфолио и первые резюме

Работодатель оценивает конкретные результаты. Портфолио должно показывать, что вы умеете выстроить структуру, объяснить сложное просто и оформить документ аккуратно. Достаточно трех работ.

  • Руководство пользователя с пошаговыми сценариями и скриншотами.
  • Документ по ГОСТ: техническое задание или программа и методика испытаний с корректным оформлением.
  • Короткая статья базы знаний или справка, чтобы показать умение писать лаконично.

Для каждой работы напишите два-три предложения о задаче, аудитории и вашем вкладе. Если в работе использованы чужие материалы, укажите это и уберите конфиденциальные данные заказчиков.

Не публикуйте реальные внутренние документы без разрешения. Для портфолио сделайте собственный пример по вымышленной системе, например "Учет заявок", и оформите его так, как оформили бы для заказчика.

Типичные ошибки начинающих

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

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

Частые вопросы

Технический писатель - это кто и чем занимается?

Это специалист, который создает документацию на продукт или систему: руководства, технические задания, инструкции и справку. Он собирает информацию у специалистов, структурирует ее и приводит в читаемый вид.

Что должен уметь технический писатель?

Ясно писать, разбираться в предмете, задавать уточняющие вопросы, работать с шаблонами и стилями в текстовом редакторе, знать основные стандарты оформления. Для ИТ-проектов полезно понимать устройство систем и работать со схемами.

Как стать техническим писателем без опыта?

Изучите основы стандартов и принципы написания инструкций, сделайте две-три работы для портфолио, например руководство пользователя и документ по ГОСТ, и откликайтесь на позиции начального уровня. Много людей приходят из аналитики, тестирования и редактуры.

Нужно ли знать ГОСТ, чтобы работать техническим писателем?

Для государственных заказчиков и проектов с обязательной проектной документацией - да, нужно понимать ЕСПД, ГОСТ 34 и правила оформления текстовых документов. Для документации коммерческих ИТ-продуктов стандарты часто заменяются внутренним руководством по стилю.

Где обучают технических писателей?

Есть профильные курсы, программы повышения квалификации и самообучение по стандартам и готовым документам. Практика на реальных проектах значит не меньше, чем теория.

Чем технический писатель отличается от копирайтера?

Копирайтер решает коммерческую или маркетинговую задачу текстом. Технический писатель описывает продукт или систему так, чтобы читатель мог выполнить действие правильно. Цель - точность и применимость, а не продажа.

Читайте также