Документатор всемогущий или Роль технического писателя в разработке ПО

А ещё он пишет справку. Причем пишет так, чтобы она была понятна даже ёжику.

Иван Корнеев

Техническая документация – неотъемлемая часть любого программного продукта. Спрос на специалистов по разработке документации продолжает расти. Однако круг задач технического писателя может довольно сильно различаться в зависимости от стандартов компании.

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

Анализ и проектирование
Главная задача на данном этапе – продумать, как конечному пользователю будет удобнее, эффективнее, интереснее и легче работать с программой. Документатор выступает здесь в роли эксперта по терминологии. Важно, чтобы все разговаривали на одном языке, простом и понятном.
Кроме того, есть возможность начать изучение будущего продукта, познакомиться с техпроектами и тем, что впоследствии нужно будет описать.

Разработка
На этапе разработки часто возникают вопросы: «А как должна вести себя программа, если …». И еще чаще это самое «если» трансформируется в различные сообщения и предупреждения. Что здесь требуется от писателя – чтобы после прочтения такого сообщения у пользователя не возникло ощущения «Я все сломал»:

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

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

Документирование

Здесь технический писатель выходит на первый план. Разрабатываются описания, снимаются скриншоты и обучающие видеоролики. В помощь писателю – всевозможные проектные документы, предварительные описания, сделанные разработчиками, например, на корпоративной Wiki, консультации от разработчиков и тестировщиков, шаблоны и примеры описаний. Итогом станут обновленный комплект документации в нужных форматах (веб-справка, PDF-документы), встроенная справочная система и система обучения.


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

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

Подводя итоги
Технический писатель – этакий любознательный зануда. Он старается охватить взглядом весь продукт целиком (например, чтобы выстроить структуру будущей книги), но не упускает при этом каждой детали (одно неучтенное изменение – и треть скриншотов придется переснимать). Он должен уметь задать правильный вопрос, и обладать аналитическим складом ума, чтобы интерпретировать полученный ответ. Квалифицированный технический писатель умеет разрабатывать лаконичный и понятный текст, предоставлять информацию в различных видах и разными способами, иллюстрировать ее примерами, приближенными к бизнес-реальности заказчика.