Курс: REQ-028
Длительность: 16 ч.
Длительность: 16 ч.
Описание
В ходе курса рассматривается унифицированный процесс создания пользовательской документации – начиная с продумывания структуры до проведения рецензирования и публикации.Много внимания в курсе уделяется вопросам корректного формулирования и оформления текста.
Слушателям будет предложено проанализировать множество примеров неудачных формулировок, взятых из разных источников, и исправить их.
Написание технических документов (технических заданий, спецификаций требований и других) не является естественной для техписателя работой, но технический писатель должен понимать их и получать из них информацию для написания документации пользователя. Поэтому в курсе рассматривается одна из форм описания требований – сценарии использования, которые могут быть преобразованы в пошаговые инструкции для пользователей.
Разбираемые темы
1. Качество документации.- Задачи технического писателя (теория 60 минут, практика 20 минут);
- Требования к документации (теория 50 минут, практика 20 минут).
- Создание документации как часть проекта по разработке ПО (теория 30 минут, практика 20 минут);
- Этапы разработки документации (теория 30 минут);
- Задание на разработку документации (теория 15 минут).
- Разновидности технических документов (теория 30 минут);
- Форма и структура документа, типы информации (теория 40 минут);
- Сценарии использования (теория 70 минут, практика 40 минут);
- Разработка функциональной части документа (теория 15 минут);
- Разработка справочных и описательных частей документа (теория 15 минут);
- Структурно-обусловленные раздел (теория 15 минут).
- Основные принципы изложения (теория 120 минут, практика 30 минут);
- Разбор примеров некачественных текстов (практика 40 минут);
- Оформление документов (теория 40 минут);
- Отличия русско- и англоязычной документации (теория 40 минут);
- Описания для специфических элементов (теория 40 минут);
- Обеспечение качества документации (теория 40 минут, практика 30 минут).
- Рекомендации по работе с MS Word (теория 40 минут, практика 40 минут);
- Дополнительные онлайн ресурсы и полезные иснтрументы (теория 30 минут).
Цели
Основная задача курса – снабдить слушателя профессиональными знаниями и навыками, необходимыми для создания пользовательской документации к программным продуктам.
После завершения обучения слушатели смогут:
- определять требования к документации и руководствоваться ими в работе;
- улучшить навык корректного изложения информации;
- применять правила организации и оформления документации;
- находить и исправлять типовые ошибки в технической документации;
- использовать продвинутые средства форматирования текста на примере MS Word.
Целевая аудитория
Программа ориентирована на технических писателей, в том числе начинающих.Предварительная подготовка
Для качественного освоения программы требуется:- общее представление о разработке ПО;
- опыт использования текстовых процессоров и других программных продуктов для работы с текстом.
После окончания курса выдаётся сертификат на бланке Luxoft Training
