Documentat.io

Интенсивный семинар для практикующих технических писателей.

Без привязки к конкретным типам документов и документационным методологиям расскажем, как сделать ваш текст лучше, как описывать сложные программные (и вообще технические) системы, и как выработать объективные критерии качества документации и донести их до всей команды.

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

Наш опыт показывает, что этот курс наиболее полезен техписателям с 1–2 годами профессионального опыта

• Жизненные циклы технического документа: большой цикл (от бизнес-проблемы до ее решения) и малый цикл (от постановки задачи на написание документа до его приемки). Краеугольные камни технического документа.

• Заочное профилирование целевой аудитории: кому мы пишем? Что мы знаем о читателе? Что читатель знает об описываемом предмете?

• Типичные сценарии чтения технического текста. Выбор структуры документа и подходов к подаче информации исходя из ожидаемых сценариев чтения.

• Рецензирование документов и его виды: корректура, проверка фактологической корректности, проверка на соответствие цели. Сценарии рецензирования, личное взаимодействие редактора и автора. Антипаттерны рецензирования.

• Объективные критерии качества документа. «Источники истины»: документационные стандарты, словари, справочники по грамматике, внешние и внутренние гиды по стилю. Компромисс между доведением документа до совершенства и выдерживанием сроков. Понятие "good enough".

• Субъективные критерии качества документа, субъективные оценки при рецензировании и приемке. Ситуации «мне не нравится», «я бы написал по-другому». Разрешение неконструктивных споров в процессе рецензирования. Почему цель документа становится особенно важной на этапе рецензирования и приемки.

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

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

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

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

Формат курса