Documentat.io

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

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

На этом семинаре мы поговорим о тонкостях управления техническими писателями и о процессах документирования.

• Для руководителей отделов разработки ПО;

• Для руководителей отделов документирования;

• Для руководителей рабочих групп технических писателей;

• Для технических писателей, которые хотят навести порядок в своей команде.

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

• Оценка трудозатрат на создание документации (обзорно). Место документационных активностей в проектных планах.

• Технический документ как проектный артефакт. Цель документа. Целевая аудитория документа. Заказчик документа. Как поставить задачу на создание документа и как убедиться, что она успешно выполнена.

• Рецензирование технических документов: внутреннее (в рамках документационной команды) и внешнее (с заказчиком документа и прочими стейкхолдерами). Фактологическое и оформительское рецензирование. Количественные и неколичественные метрики качества документа, понятие "good enough".

• Выдача документа целевой аудитории. Обратная связь от читателей документа, ее сбор и анализ.

• Поддержка актуальности документации. QA-активности, связанные с документацией.

• Индустриальные документационные стандарты. «Все уже придумано до нас» или «мы пойдем своим путем»: построение корпоративного документационного стандарта на основе общепринятых индустриальных практик или с нуля.

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

• Отбор и собеседование технических писателей. Необходимое образование, опыт работы. Какие навыки нужно проверять тестовыми заданиями. «Опасные звоночки» и «приятные мелочи» в резюме и тестовых заданиях.

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

• Переход от техписателя-одиночки к команде. Переход от написания документации к управлению документационными процессами и к руководству другими техписателями.