Управляем командой технических писателей

Об авторе

Автор и ведущий семинара — Семён Факторович, руководитель отдела технической документации в компании Zodiac Interactive. Независимый консультант по вопросам документирования. Разработчик и преподаватель курса «Техническая документация» в Новосибирском государственном университете.

Доклад Семёна Факторовича на конференции Гипербатон 2016 (ВИДЕО).

Семинар 31 января 2020 г.

31 января 2020 г. этот семинар проводит М. Острогорский.

Аудитория

Семинар адресован следующим категориям слушателей:

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

Содержание

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

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

На семинаре будут рассмотрены следующие вопросы.

• Профессиональный рост технического писателя. Горизонтальное и вертикальное карьерное развитие. Горизонтальные и вертикальные карьерные ограничения. Карьерный потолок в рамках одной компании, и что делать техническому писателю, если он в него уперся.
• Переход от технического писателя-одиночки к команде. Переход от написания документации к управлению документационными процессами и к руководству другими техническими писателями.
• Отбор и собеседование технических писателей. Необходимое образование, опыт работы. Какие навыки нужно проверять тестовыми заданиями. «Опасные звоночки» и «приятные мелочи» в резюме и тестовых заданиях.
• Процессы документирования. Жизненный цикл документа с точки зрения технического писателя и с точки зрения руководителя. Постановка задачи, работа над документом и отслеживание ее прогресса, рецензирование документа и его финализация, поддержка актуальности.
• Технический документ как проектный артефакт. Цель документа. Целевая аудитория документа. Заказчик документа. Как поставить задачу на создание документа и как убедиться, что она успешно выполнена.
• Рецензирование документов: внутреннее (внутри документационной команды) и внешнее (с заказчиком документа и прочими стейкхолдерами). Фактологическое и оформительское рецензирование. Количественные и неколичественные метрики качества документа, понятие «good enough».
• Финализация документа (передача его целевой аудитории). Обратная связь от читателей документа, ее сбор и анализ (обзорно).
• Поддержка актуальности документации. QA-активности, связанные с документацией.
• Оценки трудозатрат на создание документации (обзорно). Место документационных активностей в проектных планах.
• Развитие документационной команды. «Точки роста» документационных специалистов.

Семинар касается не только (и не столько) разработки документации пользователя, но и документации разработки: технических заданий, архитектурных и тестовых документов.