Advanced Technical Writing. Продвинутый курс по технической документации [documentat.io] [Семён Факторович]

Что это за курс Интенсивный семинар для практикующих технических писателей. Без привязки к конкретным типам документов и документационным методологиям расскажем, как сделать ваш текст лучше, как описывать сложные программные (и вообще технические) системы, и как выработать объективные критерии качества документации и донести их до всей команды. Для кого Для опытных технических писателей и всех, кому по роду деятельности нужно описывать сложные технические системы. Наш опыт показывает, что этот курс наиболее полезен техписателям с 1–2 годами профессионального опыта Объективные критерии качества документа. «Источники истины»: документационные стандарты, словари, справочники по грамматике, внешние и внутренние гиды по стилю. Компромисс между доведением документа до совершенства и выдерживанием сроков. Понятие "good enough". Субъективные критерии качества документа, субъективные оценки при рецензировании и приемке. Ситуации «мне не нравится», «я бы написал по-другому». Разрешение неконструктивных споров в процессе рецензирования. Почему цель документа становится особенно важной на этапе рецензирования и приемки. Подходы к структурированию текста и к подаче информации. Принцип пирамиды. Подходы к описанию сложных технических систем. Работа с ментальными моделями, описание различных ракурсов одной и той же модели. Архитектурные документы как один из самых сложных видов технической документации. Типичные ошибки структуры и подачи информации. «Проклятие знания» и «проклятие незнания». Определение понятий через их второстепенные характеристики. Непопадание в цель и целевую аудиторию. Ошибка ракурсов. Изложение фактов в том порядке, в котором их узнавал автор. Другие варианты нарушения порядка изложения. Роль старшего технического писателя в команде. Создание культуры рецензирования, передача опыта, формирование командного вкуса. Формат курса Курс проводится в формате живых вебинаров. После завершения курса участникам будут доступны видеозаписи всех занятий.

Advanced Technical Writing. Глубокий взгляд на техническую документацию [documentat.io] [Семён Факторович]​ О курсе Это интенсивная программа для опытных технических писателей. Мы пройдемся по тому, как улучшить вашу документацию, описывать сложные технические и программные системы, а также как формировать объективные параметры качества документации и распространять их среди команды, не завязываясь на специфические типы документов или методологии. Целевая аудитория Курс предназначен для ветеранов технического писательства, а также для всех, чья работа связана с описанием сложных технических систем. Наш опыт подсказывает, что данный курс наиболее полезен для технических писателей с 1–2 годами профессионального стажа. План обучения Жизненный цикл технического документа: общий (от проблемы бизнеса до ее решения) и частный (от задачи написания документа до его утверждения). Основные элементы технического документа. Удаленное профилирование целевой аудитории: кто наши читатели? Что мы знаем о них? Что они знают об объекте описания? Обычные сценарии чтения технического текста. Выбор формата документа и подходов к представлению информации, исходя из предполагаемых сценариев чтения. Ревью документов и его разновидности: корректура, проверка фактов, соответствие целям. Сценарии ревью, личное взаимодействие между редактором и автором. Недопустимые практики ревью. Объективные параметры качества документа. "Источники правды": стандарты документации, словари, грамматические справочники, внешние и внутренние стилевые руководства. Баланс между идеальным состоянием документа и соблюдением сроков. Принцип "good enough". Субъективные параметры качества документа, субъективные оценки при ревью и утверждении. Ситуации "мне не нравится", "я бы написал по-другому". Решение бессмысленных споров во время ревью. Почему цель документа становится особенно значимой на этапе ревью и приемки. Методы структурирования текста и представления информации. Принцип пирамиды. Методы описания сложных технических систем. Работа с ментальными моделями, описание разных аспектов одной модели. Архитектурная документация как один из самых сложных типов технической документации. Распространенные ошибки в структуре и представлении информации. «Проклятье знания» и «проклятье неведения». Определение понятий через их второстепенные характеристики. Неточное определение цели и целевой аудитории. Ошибка ракурсов. Изложение фактов в порядке их получения автором. Другие нарушения последовательности изложения. Роль главного технического писателя в команде. Создание культуры ревью, передача опыта, формирование командного вкуса. Формат проведения курса Курс осуществляется в виде прямых вебинаров. После окончания курса участникам выдаются записи всех занятий. »