Эффективная разработка пользовательской документации
Всем хорошо известна фраза «Если ничего не получается, прочтите, наконец, инструкцию». Но как же написать инструкцию так, чтобы желание ее прочесть возникало еще до начала работы с программным продуктом? Как сделать ее информативной и для опытных пользователей, и для новичков? В курсе рассматривается процесс создания пользовательской докуменнтации к программным продуктам. В частности, обсуждаются: структура документа, правила изложения, правила форматирования текста и критерии качества документации.
16 ак.ч.
Онлайн
REQ-028
Эффективная разработка пользовательской документации
Записаться на курс
Длительность
16 ак.ч.
Локация
Онлайн
Код
REQ-028
Расписание и цены
06.12.2021 - 13.12.2021
17.01.2022 - 20.01.2022
19 800 руб.
5 900 грн.
Планируете обучить команду из 7-8 или более человек?
Закажите корпоративное обучение с учетом ваших потребностей
Эффективная разработка пользовательской документации
Записаться на курс
Длительность
16 ак.ч.
Локация
Онлайн
Код
REQ-028
Расписание и цены
06.12.2021 - 13.12.2021
17.01.2022 - 20.01.2022
19 800 руб.
5 900 грн.
Планируете обучить команду из 7-8 или более человек?
Закажите корпоративное обучение с учетом ваших потребностей

Описание

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

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

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

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

После прохождения курса выдается
сертификат на бланке Luxoft Training

Цели

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

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

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

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

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

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

Для качественного освоения программы требуется:
  • общее представление о разработке ПО; 
  • опыт использования текстовых процессоров и других программных продуктов для работы с текстом.

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

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

Примечание

Раcписание курсов
Вид:
06.12.2021 - 13.12.2021
17:00-20:00
Локация:Онлайн
Длительность:16 ак.ч.
Время:17:00-20:00
19 800 руб.
5 900 грн.
Записаться
17.01.2022 - 20.01.2022
10:30-14:30
Локация:Онлайн
Длительность:16 ак.ч.
Время:10:30-14:30
19 800 руб.
5 900 грн.
Записаться
Смотреть полное расписание
Тренеры
Онуфриенко Екатерина
Специалист в области обеспечения качества разработки ПО
Катерина имеет опыт управления проектами на всех этапах жизненного цикла проекта. Профессиональный опыт начинался от системного / бизнес-инженера до руководителей ИТ-департаментов.

Области: Таможня, жилищно-коммунальный сектор в правительственных проектах автоматизации деятельности, а также в банковском секторе и в автомобильном бизнесе.

Приймак Дмитрий
Эксперт по системному и бизнес-анализу

В ИТ-отрасли Дмитрий работает с 1992 г. Начинал свою карьеру как разработчик и архитектор, принимал участие в разработке систем автоматизированного проектирования (САПР), систем расчета заработной платы, учетных систем и даже русско-украинского переводчика. 

Смена мест работы лишь расширяла кругозор и ставила новые более интересные задачи, но не меняла направленности – во всех компаниях, где работал Дмитрий, он управлял ИТ-подразделениями и/или ИТ-проектами. При этом он всегда стремился сделать разрабатываемые системы «умными» и удобными для конечных пользователей, превратить компьютер из «продвинутой пишущей машинки» в инструмент анализа и управления бизнесом.

То, что успешность ИТ-проекта зависит от правильно сформулированных требований, он понял достаточно быстро на основе собственного опыта. А чтобы требования были выявлены и описаны корректно, необходимо понять специфику бизнеса компании-заказчика, выяснить истинные потребности стейкхолдеров и суметь потом всю полученную информацию передать разработчикам. Так постепенно интересы Дмитрия смещались от просто разработки программного обеспечения к повышению эффективности деятельности компаний.

В 2004 г. он окончательно перешел в сферу бизнес- и системного анализа, но при этом сохранил верность ИТ, поэтому практически все его проекты так или иначе связаны с автоматизацией и оптимизацией бизнес-процессов. 

Начиная с 2006 г. Дмитрий продолжает свою карьеру исключительно в ИТ-компаниях, профессионально создающих программное обеспечение. Это зависело от нескольких факторов. Во-первых, появляется возможность в ходе каждого очередного проекта изучить новую предметную область, новый вид бизнеса, нового заказчика, что прекрасно расширяет кругозор и тренирует способность поиска эффективных решений. Во-вторых, именно в «фабриках программного обеспечения» процесс разработки ПО построен по-настоящему полно и качественно.
 
В ряде проектов Дмитрий выполнял роль руководителя проекта, но роль аналитика – специалиста, отвечающего за выявление и удовлетворение потребностей заказчика, – всегда была ему ближе. Для того чтобы лучше понимать современные подходы к управлению бизнесом (а значит лучше понимать потребности, мотивы и опасения заказчиков), Дмитрий получил в 2012 г. второе высшее образование – степень МВА (Master of Business Administration).

Одна из составляющих роли аналитика в ИТ-проектах – необходимость объяснять простыми словами порой достаточно сложные понятия: разработчикам – нюансы бизнеса заказчика, заказчику – нюансы ИТ-технологий и решений. Умение объяснять, в котором, кроме всего, Дмитрию помогает его давнее увлечение психологией, постепенно стало превращаться в самостоятельную деятельность – проведение тренингов, мастер-классов, консалтинг ИТ-команд.

В итоге с 2012 г. Дмитрий стал штатным экспертом по бизнес-анализу Luxoft Training. 

В качестве эксперта Дмитрий проводил курсы для сотрудников таких компаний, как Райффайзен Банк Аваль, АСТЕЛИТ, Альфа-банк Украина, МТС Украина, Киевстар, ELEKS, ГРУППА КОМПАНИЙ FOZZY GROUP, Миратех, УкрСиббанк, Энвижн Групп, iBox, Инфопульс Украина, ПриватБанк, Укрэксимбанк, РОВНОАЗОТ OSTCHEM, ЮРИЯ-ФАРМ, Укрсоцбанк, ПроКредит Банк и других.

Статьи эксперта в СМИ:

  • Как язык UML помогает организовать работу IT-проекта
  • https://tproger.ru/articles/kak-jazyk-uml-pomogaet-organizovat-rabotu-it-proekta/

Отзывы (2)
Общее впечатление – очень положительное, все доходчиво и понятно. Наиболее полезны практические задания с разбором их выполнения. Написание СИС, выбор оптимальных вариантов.
Участник тренинга
Получил исчерпывающую информацию о профессии технического писателя. Тренинг помог систематизировать уже имеющиеся знания и навыки. Новой для меня была информация о тестировании тех. документации, что является весьма полезным в нашей работе, данную функцию (опцию) я хочу предложить использовать руководству.
Участник тренинга
Ваши преимущества
Экспертность
Тренеры-эксперты из реальных проектов крупнейших компаний, лидеров в своей отрасли
Живое обучение
“Живая” коммуникация с тренером даже в онлайн-формате
Практика
Максимально наполненные практикой занятия, работа в группах, выполнение домашних заданий
Для физических лиц
10%
Скидка на любой курс
5%
Бонус от стоимости курса после прохождения
5%
Бонус за рекомендацию курсов Luxoft Training
Оценка и обучение ИТ-специалистов по ключевым направлениям разработки программного обеспечения. Курсы от экспертов-практиков по языкам программирования, системному и бизнес-анализу, архитектуре ПО, ручному и автоматизированному тестированию ПО, Big Data и машинному обучению, управлению проектами и Agile. Luxoft Training – первый учебный центр в России, авторизованный IIBA. Действует скидка 10% на обучение физических лиц.
Остались вопросы?
Связаться с нами
Пользователь только что записался на курс ""
Спасибо!
Форма отправлена успешно.