Курс: Эффективная разработка пользовательской документации

Продолжительность курса: 16 ак. ч.

Описание курса:
В ходе курса рассматривается унифицированный процесс создания пользовательской документации – начиная с продумывания структуры до проведения рецензирования и публикации.
Много внимания в курсе уделяется вопросам корректного формулирования и оформления текста.
Слушателям будет предложено проанализировать множество примеров неудачных формулировок, взятых из разных источников, и исправить их.
Написание технических документов (технических заданий, спецификаций требований и других) не является естественной для техписателя работой, но технический писатель должен понимать их и получать из них информацию для написания документации пользователя. Поэтому в курсе рассматривается одна из форм описания требований – сценарии использования, которые могут быть преобразованы в пошаговые инструкции для пользователей.

Аудитория:
Программа ориентирована на технических писателей, в том числе начинающих.

Необходимая подготовка:
• общее представление о разработке ПО;
• опыт использования текстовых процессоров и других программных продуктов для работы с текстом.

Программа курса:
Модуль 1. Качество документации
• Задачи технического писателя
• Требования к документации

Модуль 2. Этапы создания документации и виды работ
• Создание документации как часть проекта по разработке ПО
• Этапы разработки документации
• Задание на разработку документации

Модуль 3. Виды, типы и структура документов
• Разновидности технических документов
• Форма и структура документа, типы информации
• Сценарии использования
• Разработка функциональной части документа
• Разработка справочных и описательных частей документа
• Структурно-обусловленные разделы

Модуль 4. Разработка и организация текста
• Основные принципы изложения
• Разбор примеров некачественных текстов
• Оформление документов
• Отличия русско- и англоязычной документации
• Описания для специфических элементов
• Обеспечение качества документации

Модуль 5. Инструментарий и ресурсы для технического писателя
• Рекомендации по работе с MS Word
• Дополнительные онлайн ресурсы и полезные инструменты

Окончательная цена указывается в договоре на обучение.