Эффективная разработка пользовательской документации
Длительность
16 ак.ч.
Локация
Онлайн
Код
REQ-028
10.03.2025 - 13.03.2025
24 500 руб.
* Для физических лиц действует скидка 10% Закажите корпоративное обучение с учетом ваших потребностей
Описание
В ходе курса рассматривается унифицированный процесс создания пользовательской документации – начиная с продумывания структуры до проведения рецензирования и публикации.Много внимания в курсе уделяется вопросам корректного формулирования и оформления текста.
Слушателям будет предложено проанализировать множество примеров неудачных формулировок, взятых из разных источников, и исправить их.
Написание технических документов (технических заданий, спецификаций требований и других) не является естественной для техписателя работой, но технический писатель должен понимать их и получать из них информацию для написания документации пользователя. Поэтому в курсе рассматривается одна из форм описания требований – сценарии использования, которые могут быть преобразованы в пошаговые инструкции для пользователей.
После прохождения курса выдается
удостоверение о повышении квалификации государственного образца
удостоверение о повышении квалификации государственного образца
Цели
Основная задача курса – снабдить слушателя профессиональными знаниями и навыками, необходимыми для создания пользовательской документации к программным продуктам.
После завершения обучения слушатели смогут:
- определять требования к документации и руководствоваться ими в работе;
- улучшить навык корректного изложения информации;
- применять правила организации и оформления документации;
- находить и исправлять типовые ошибки в технической документации;
- использовать продвинутые средства форматирования текста на примере 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писание курсов
Вид:
Тренеры
Подолина Ольга
Специалист в области системного и бизнес-анализа
Работает аналитиком с 2006 года. Специализация: проектирование информационных систем (системы электронного документооборота, их интеграции с другими информационными системами).
Работает аналитиком с 2006 года. Специализация: проектирование информационных систем (системы электронного документооборота, их интеграции с другими информационными системами).
О проектах:
Тренер с 2014 года. Курсы:- «Проектирование приложений с использованием UML»
- «Применение системного анализа в процессах автоматизации деятельности организаций»
- «Управление требованиями»
- «Моделирование бизнес-процессов» и пр.
Отзывы (4)
Общее впечатление – очень положительное, все доходчиво и понятно. Наиболее полезны практические задания с разбором их выполнения. Написание СИС, выбор оптимальных вариантов.
Получил исчерпывающую информацию о профессии технического писателя. Тренинг помог систематизировать уже имеющиеся знания и навыки. Новой для меня была информация о тестировании тех. документации, что является весьма полезным в нашей работе, данную функцию (опцию) я хочу предложить использовать руководству.
Понравилось, что нам рассказали о документации и общих практиках, поделились пониманием принципов написания пользовательской документации. Весь курс очень хорошо структурирован, материалы хорошие, много практических советов и обсуждений. Никакой "воды" - всё только по делу.
Хороший курс. Больше всего мне понравилось, как были представлены примеры, объяснения, часть сценариев использования (use case), а также занятие по лайфхакам и фишкам в MS Word, ясность, четкость и динамичность материала. Полезным было практически все.
Рекомендуемые дополнительные материалы, источники
Философт (статьи и форум).
Языковой портал Microsoft (терминология).
Word MVP Site (статьи по Word).
Technical Writing Tips (общие советы).
