Documentat.io

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

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

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

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

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

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

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

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

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

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

• Рецензирование технических документов: внутреннее (в рамках документационной команды) и внешнее (с заказчиком документа и прочими стейкхолдерами). Фактологическое и оформительское рецензирование. Субъективные и объективные критерии качества документации. Источники истины, внутренние и внешние гиды по стилю.

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

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