О чём курс
Создание инструкций процесс нелегкий. Как сделать ее информативной и для опытных пользователей, и для новичков? Как оформить в соотвествии со всеми требованиями? Какие инструменты облегчают процесс создания инструкции? В чем принципиальное отличие тире от дифиса, и почему важно уметь правильно их расставлять?. Все эти вопросы рассматириваются в данном курсе, в частности, обсуждаются: структура документа, правила изложения, правила форматирования текста и критерии качества документации. Слушателям будет предложено проанализировать множество примеров неудачных формулировок, взятых из разных источников, и исправить их.
Написание технических документов (технических заданий, спецификаций требований и других) не является естественной для техписателя работой, но технический писатель должен понимать их и получать из них информацию для написания документации пользователя. Поэтому в курсе рассматривается одна из форм описания требований – сценарии использования, которые могут быть преобразованы в пошаговые инструкции для пользователей.
Цели
Основная задача курса – снабдить слушателя профессиональными знаниями и навыками, необходимыми для создания пользовательской документации к программным продуктам.
После завершения обучения слушатели смогут:
- 1.определять требования к документации и руководствоваться ими в работе;
- 2.улучшить навык корректного изложения информации;
- 3.применять правила организации и оформления документации;
- 4.находить и исправлять типовые ошибки в технической документации;
- 5.использовать продвинутые средства форматирования текста на примере MS Word.
Целевая аудитория
Технические писатели, состемные аналитики, архитекторы ПО, руководители проектов
Предварительная подготовка
Для качественного освоения программы требуется:
1.общее представление о разработке ПО;
2.опыт использования текстовых процессоров и других программных продуктов для работы с текстом.
1.общее представление о разработке ПО;
2.опыт использования текстовых процессоров и других программных продуктов для работы с текстом.
Для кого
Бизнес-аналитик
Системный аналитик
Технический писатель
Руководитель проекта
Улучшаемые навыки
Анализ требований пользователей
Структурирование и организация информации
Техническое написание
Использование инструментов для документации
Обратная связь и улучшение документации
Темы курса
01
Качество документации
- Задачи технического писателя (теория – 60 мин, практика – 20 мин);
- Требования к документации (теория – 50 мин, практика 20 мин).
02
Этапы создания документации и виды работ
- Создание документации как часть проекта по разработке ПО (теория – 30 мин, практика – 20 мин);
- Этапы разработки документации (теория – 30 мин);
- Задание на разработку документации (теория – 15 мин).
03
Виды, типы и структура документов
- Разновидности технических документов (теория – 30 мин);
- Форма и структура документа, типы информации (теория – 40 мин);
- Сценарии использования (теория – 70 мин, практика – 40 мин);
- Разработка функциональной части документа (теория – 15 мин);
- Разработка справочных и описательных частей документа (теория – 15 мин);
- Структурно-обусловленные разделы (теория – 15 мин).
04
Разработка и организация текста
- Основные принципы изложения (теория – 120 мин, практика – 30 мин);
- Разбор примеров некачественных текстов (практика – 40 мин);
- Оформление документов (теория – 40 мин);
- Отличия русско- и англоязычной документации (теория – 40 мин);
- Описания для специфических элементов (теория – 40 мин);
- Обеспечение качества документации (теория – 40 мин, практика – 30 мин).
05
Инструментарий и ресурсы для технического писателя
- Рекомендации по работе с MS Word (теория – 40 мин, практика – 40 мин);
- Дополнительные онлайн ресурсы и полезные инструменты (теория – 30 мин).
Чему вы научитесь
01
Выявлять и понимать потребности конечных пользователей для создания документации
02
Создавать логичную структуру документации
03
Писать ясные и точные инструкции, руководства и справочные материалы
04
Работать с различными программами и платформами для создания, редактирования и публикации документации
05
Собирать и анализировать отзывы пользователей о документации
Ведущий курса
Подолина Ольга
Специалист в области системного и бизнес-анализа
Записаться на курс
27 000 ₽
24 300 ₽ — для физ. лиц
Юр. лицо — 27 000 ₽
Физ. лицо — 24 300 ₽
10.03.2025, Онлайн
10.03.2025, Онлайн
Открытая дата
Отзывы о курсе
Отзывы учеников
Общее впечатление – очень положительное, все доходчиво и понятно. Наиболее полезны практические задания с разбором их выполнения. Написание СИС, выбор оптимальных вариантов.
Получил исчерпывающую информацию о профессии технического писателя. Тренинг помог систематизировать уже имеющиеся знания и навыки. Новой для меня была информация о тестировании тех. документации, что является весьма полезным в нашей работе, данную функцию (опцию) я хочу предложить использовать руководству.
Понравилось, что нам рассказали о документации и общих практиках, поделились пониманием принципов написания пользовательской документации. Весь курс очень хорошо структурирован, материалы хорошие, много практических советов и обсуждений. Никакой "воды" - всё только по делу.
Хороший курс. Больше всего мне понравилось, как были представлены примеры, объяснения, часть сценариев использования (use case), а также занятие по лайфхакам и фишкам в MS Word, ясность, четкость и динамичность материала. Полезным было практически все.
Наши ученики работают в:
Наши клиенты
