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

Создавайте документацию, которая будет полезна и новичкам, и экспертам — от первых строк до релиза продукта! Курс раскрывает универсальные принципы разработки технической документации: от структуры до публикации. Вы освоите правила ясного изложения, форматирования и работы с MS Word, а также научитесь адаптировать контент под разный уровень подготовки читателей.

• Задачи технического писателя.
• Требования к документации.
• Создание документации как часть проекта по разработке ПО.
• Этапы разработки документации.
• Задание на разработку документации.
• Разновидности технических документов.
• Форма и структура документа, типы информации.
• Сценарии использования.
• Разработка функциональной части документа.
• Разработка справочных и описательных частей документа.
• Структурно-обусловленные разделы.
• Основные принципы изложения.
• Разбор примеров некачественных текстов.
• Оформление документов.
• Отличия русско- и англоязычной документации.
• Описания для специфических элементов.
• Обеспечение качества документации.
• Инструментарий и ресурсы для технического писателя.
• Рекомендации по работе с MS Word.
• Дополнительные онлайн-ресурсы и полезные инструменты.