Фоновый баннер

Разработка технической документации. Практика

Москва
Иконка

Дата: 14.12.2020

Цена: 14600 руб.

Записаться на курс

Подробнее о курсе

Крактое описание курса
Курс посвящен процессу документирования в IT проектах. В нем представлены основные принципы создания технического документа. Рассмотрены типичные ошибки разработчиков технической документации. Описаны особенности профессии технического писателя, и предложены рекомендации по настройке процесса документирования

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

  • Технические писатели
  • Сотрудники технической поддержки
  • Аналитики
  • Руководители и менеджеры проектов

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

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

  • использовать основную терминологию в документирования
  • разбираться в видах и структуре документов
  • вести сбор и анализ информации, владеть техниками сбора и методологией
  • выявлять пробелы в технической документации
  • создавать качественные и эффективные документа
  • использовать ГОСТы при разработке документов

Краткое содержание курса
Модуль 1

  • Профессия технический писатель
  • Особенности написания технической документации
  • Этапы документирования
  • Работа с задачей на документирование
  • Основные принципы написания технической документации

Практическое задание 1: Обсуждение фрагментов инструкция
Цель: Продемонстрировать разницу между корректными и некорректными формулировками и оформлением в инструкциях
Практическое задание 2: Написание простой инструкции

Модуль 2

  • Особенности разработки ГОСТовой документации
  • Разработка внутреннего руководство по стилю
  • Типы программных продуктов
  • Предмет документирования
  • Способы чтения документации пользователем
  • Детальность изложения в технической документации
  • ГОСТ 19
  • ГОСТ 34
  • Структура ТЗ
  • Структура Руководства пользователя
  • Международные стандарты документирования
  • Особенности написания документации на английском языке

Практическое задание 1: Поиск необходимого документа и чтение необходимого ГОСТа
Цель: Продемонстрировать слушателю наполненность и смысл ГОСТов для документирования
Практическое задание 2: Оформление Руководства пользователя по ГОСТу
Цель: Проигрывание реальной задачи технического писателя для демонстрации некорректного выбора сроков на документирование

Модуль 3

  • Основные ошибки в вёрстке технической документации
  • Правила вёрстки
  • Плюсы и минусы различных программ для вёрстки
  • Основные принципы дизайна
  • Роль скриншотов в документе
  • Правила оформления скриншотов

Практическое задание 1: Сверстать документ
Цель: Проверить понимание слушателем основных принципов вёрстки
Практическое задание 2: Найти 3 некорректных и 3 корректных скриншота
Цель: Проверить понимания слушателями правил оформления скриншотов

Модуль 4

  • ПО для планирования рабочего времени
  • ПО для написания документации
  • ПО для создания и оформления скриншотов
  • ПО для создания иллюстраций и схематических изображений
  • ПО для работы с виртуальными машинами
  • Создание обучающих видеороликов
  • ПО для создания обучающих видеороликов

Практическое задание 1: Написать инструкцию и вставить в неё скриншоты
Цель: Проверить понимание пройденных на курсе тем


Отзывы по курсу