Разбираемые темы:
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 минут).