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

Всем хорошо известна фраза «Если ничего не получается, прочтите, наконец, инструкцию». Но как же написать инструкцию так, чтобы желание ее прочесть возникало еще до начала работы с программным продуктом? Как сделать ее информативной и для опытных пользователей, и для новичков? В курсе рассматривается процесс создания пользовательской докуменнтации к программным продуктам. В частности, обсуждаются: структура документа, правила изложения, правила форматирования текста и критерии качества документации. 

Модуль 1

• Задачи технического писателя (теория – 60 мин, практика – 20 мин);
• Требования к документации (теория – 50 мин, практика 20 мин).
  

Модуль 2

• Создание документации как часть проекта по разработке ПО (теория – 30 мин, практика – 20 мин); 
• Этапы разработки документации (теория – 30 мин); 
• Задание на разработку документации (теория – 15 мин).
  

Модуль 3

• Разновидности технических документов (теория – 30 мин); 
• Форма и структура документа, типы информации (теория – 40 мин); 
• Сценарии использования (теория – 70 мин, практика – 40 мин); 
• Разработка функциональной части документа (теория – 15 мин); 
• Разработка справочных и описательных частей документа (теория – 15 мин); 
• Структурно-обусловленные разделы (теория – 15 мин).
  

Модуль 4

• Основные принципы изложения (теория – 120 мин, практика – 30 мин); 
• Разбор примеров некачественных текстов (практика – 40 мин); 
• Оформление документов (теория – 40 мин); 
• Отличия русско- и англоязычной документации (теория – 40 мин); 
• Описания для специфических элементов (теория – 40 мин); 
• Обеспечение качества документации (теория – 40 мин, практика – 30 мин).
  

Модуль 5

• Рекомендации по работе с MS Word (теория – 40 мин, практика – 40 мин);
• Дополнительные онлайн ресурсы и полезные инструменты (теория – 30 мин).