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

3.5

16 часов

Сложность

Начинающий

Тип обучения

Курс

Формат обучения

С проверкой домашнего задания

Трудоустройство

Отсутствует

Сертификат

Да

Стоимость курса

24 500 ₽

нет рассрочки

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

Что вы получите после обучения

Сертификат, ссылками на который можно делиться с другими людьми

Вас будут обучать

Подолина Ольга

курса

Специалист в области системного и бизнес-анализа

Работает аналитиком с 2006 года. Специализация: проектирование информационных систем (системы электронного документооборота, их интеграции с другими информационными системами).

О проектах:

Тренер с 2014 года. Курсы:

«Проектирование приложений с использованием UML»
«Применение системного анализа в процессах автоматизации деятельности организаций»
«Управление требованиями»
«Моделирование бизнес-процессов» и пр.

Автор статей по тематике электронного документооборота.

Образовательная организация

IBS Training Center

4.5

219 отзывов

Оценка и обучение ИТ-специалистов по ключевым направлениям разработки программного обеспечения. Курсы от экспертов-практиков по языкам программирования, системному и бизнес-анализу, архитектуре ПО, ручному и автоматизированному тестированию ПО, Big Data и машинному обучению, управлению проектами и Agile. Действует скидка 10% на обучение физических лиц.

Программа курса

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