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