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

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

Описание

В ходе курса рассматривается унифицированный процесс создания пользовательской документации – начиная с продумывания структуры до проведения рецензирования и публикации.

Много внимания в курсе уделяется вопросам корректного формулирования и оформления текста.

Слушателям будет предложено проанализировать множество примеров неудачных формулировок, взятых из разных источников, и исправить их.

Написание технических документов (технических заданий, спецификаций требований и других) не является естественной для техписателя работой, но технический писатель должен понимать их и получать из них информацию для написания документации пользователя. Поэтому в курсе рассматривается одна из форм описания требований – сценарии использования, которые могут быть преобразованы в пошаговые инструкции для пользователей.

Разбираемые темы

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 минут).

Цели

Основная задача курса – снабдить слушателя профессиональными знаниями и навыками, необходимыми для создания пользовательской документации к программным продуктам.

После завершения обучения слушатели смогут:

  • определять требования к документации и руководствоваться ими в работе;
  • улучшить навык корректного изложения информации;
  • применять правила организации и оформления документации;
  • находить и исправлять типовые ошибки в технической документации;
  • использовать продвинутые средства форматирования текста на примере MS Word.

Целевая аудитория

Программа ориентирована на технических писателей, в том числе начинающих.

Предварительная подготовка

Для качественного освоения программы требуется:
  • общее представление о разработке ПО; 
  • опыт использования текстовых процессоров и других программных продуктов для работы с текстом.
После окончания курса выдаётся сертификат на бланке Luxoft Training
Раcписание курса в Цены
Не подходят даты, время или хотите заказать корпоративное обучение для команды?
+
Предложите свой вариант
Онлайн 19 800 руб.
5 900 грн.
Отзывы:
Участник тренинга
Общее впечатление – очень положительное, все доходчиво и понятно. Наиболее полезны практические задания с разбором их выполнения. Написание СИС, выбор оптимальных вариантов.
Участник тренинга
Получил исчерпывающую информацию о профессии технического писателя. Тренинг помог систематизировать уже имеющиеся знания и навыки. Новой для меня была информация о тестировании тех. документации, что является весьма полезным в нашей работе, данную функцию (опцию) я хочу предложить использовать руководству.

Рекомендуемые дополнительные материалы, источники:

Примечание:

NULL

Записаться на курс

Выбрать дату
Если Вам не подходят дата и место проведения тренинга, Вы можете оставить заявку на участие в нем в любом из городов, где представлены филиалы Luxoft Training. Для этого выберите вариант "Открытая дата" и укажите желаемое место проведения курса.
Желаемое место проведения курса
Вы можете оставить заявку на корпоративное обучение сотрудников Вашей компании в любом городе России или Украины, выбрав вариант "Другой город"
Фамилия *

Имя *

Отчество

Контактный E-mail *

Компания *

Телефон *

Город *

Комментарий
Оценка и обучение ИТ-специалистов по ключевым направлениям разработки программного обеспечения. Курсы от экспертов-практиков по языкам программирования, системному и бизнес-анализу, архитектуре ПО, ручному и автоматизированному тестированию ПО, Big Data и машинному обучению, управлению проектами и Agile. Luxoft Training – первый учебный центр в России, авторизованный IIBA. Действует скидка 10% на обучение физических лиц.
Остались вопросы?
Связаться с нами
Пользователь только что записался на курс ""
Спасибо!
Форма отправлена успешно.