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

Описание

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

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

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

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

Цели

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

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

  • определять требования к документации и руководствоваться ими в работе;
  • улучшить навык корректного изложения информации;
  • применять правила организации и оформления документации;
  • находить и исправлять типовые ошибки в технической документации;
  • использовать продвинутые средства форматирования текста на примере 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писание курсов
Вид:
15.12.2022 - 22.12.2022
10:00-12:40
Локация:Онлайн
Длительность:16 ак.ч.
Время:10:00-12:40
21 800 руб.
Записаться
Смотреть полное расписание
Тренеры
Григорьева Мария
Специалист в области системного анализа
Руководитель продукта, ведущий бизнес и системный аналитик, консультант с опытом крупных международных проектов по автоматизации и оптимизации бизнес-процессов для банковской сферы и телекома. Имеет опыт работе более 15 лет в управлении продуктами, бизнес-анализе и системном анализе на руководящих должностях. Свои проекты по разработке и внедрению реализовывала в сфере банковских/финтех- и телекоммуникационных решений по всему миру. Также имеет более 7 лет опыта преподавания в Университете ИТМО, «Банк Санкт-Петербург», «Scout Academy» и образовательном центре Netcraker.

О проектах:

В рамках своих проектов работа с ИТ-компаниями, мобильными операторам и образовательными учреждениями. Занималась аналитикой, разработкой финансового сервиса, управлением командой разработки (от 3 до 16 человек), построением процесса разработки по SCRUM, Kanban, управлением планами проектов, планированием развития продукта и т. д.

Курсы, сертификаты, членство в профессиональных организациях:

  • 2015 -2017 - Project management, People management, Motivation, Communication skills, - внутреннее обучение Netcracker
  • 2013 - University of Jyväskylä. Summer School: "S2: Higher Level Entity Relationship Modelling", "STAT1: Industrial Data Science", "COM1: Modelling Strategic Decisions", "COM6: Advanced Methods for Classification of Big High Dimensional Data"
  • 2012 - Основы SmartVista, БПЦ
  • 2011 - Программа обучения PM, внутреннее обучение "Epam systems"
  • 2010 - Курсы бизнес-аналитики, внутреннее обучение "Epam systems"

Отзывы (4)
Общее впечатление – очень положительное, все доходчиво и понятно. Наиболее полезны практические задания с разбором их выполнения. Написание СИС, выбор оптимальных вариантов.
Участник тренинга
Получил исчерпывающую информацию о профессии технического писателя. Тренинг помог систематизировать уже имеющиеся знания и навыки. Новой для меня была информация о тестировании тех. документации, что является весьма полезным в нашей работе, данную функцию (опцию) я хочу предложить использовать руководству.
Участник тренинга
Понравилось, что нам рассказали о документации и общих практиках, поделились пониманием принципов написания пользовательской документации. Весь курс очень хорошо структурирован, материалы хорошие, много практических советов и обсуждений. Никакой "воды" - всё только по делу.
Участник тренинга
Хороший курс. Больше всего мне понравилось, как были представлены примеры, объяснения, часть сценариев использования (use case), а также занятие по лайфхакам и фишкам в MS Word, ясность, четкость и динамичность материала. Полезным было практически все.
Участник тренинга
Показать все отзывы
Ваши преимущества
Экспертность
Тренеры-эксперты из реальных проектов крупнейших компаний, лидеров в своей отрасли
Живое обучение
“Живая” коммуникация с тренером даже в онлайн-формате
Практика
Максимально наполненные практикой занятия, работа в группах, выполнение домашних заданий
Пользователь только что записался на курс ""
Спасибо!
Форма отправлена успешно.