[documentat.io] [Семён Факторович]

[SlivInfoKurs]

Advanced Technical Writing. Глубокий взгляд на техническую документацию []

О курсе
Это интенсивная программа для опытных технических писателей.

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

Целевая аудитория
Курс предназначен для ветеранов технического писательства, а также для всех, чья работа связана с описанием сложных технических систем.

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

План обучения

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

Формат проведения курса
Курс осуществляется в виде прямых вебинаров. После окончания курса участникам выдаются записи всех занятий.

Скрытая ссылка

»

Этот курс появится в скором времени на форуме SLIVINFOKURS.BIZ. Проверьте по поиску форума, возможно данный курс уже слит.

​