Технический писатель. Разработка и оформление технической документации

О курсе:

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

Для кого:

Для технических писателей, специалистов, ответственных за разработку и сопровождение технической документации

Программа:

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

Ключевые темы программы:

1. Техническая коммуникация и техническое писательство. Особенности технического документирования. Стили технической документации.
2. Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам ГОСТ, ISO, ITU, IEEE. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД).

   Мастер-класс: Оформление ТЗ по ГОСТ 34.602-2020. Создание и оформление руководства пользователя, технических условий.

3. Методы и приемы работы с техническими текстами. Этапы создания технического текста.
4. Техническая коммуникация и техническое писательство. Особенности технического документирования. Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления.
5. Искусственный интеллект в работе технического писателя: промты для создания документации, форматирования технических текстов программного кода, создание изображений и инфографики. Копирование и вставка в документ. Форматирование документа после ИИ, чтобы никто не догадался. Модели ИИ для создания документации.
6. Оформление технической документации в соответствии с ГОСТ Р 2.102-2023 «Единая система конструкторской документации» (ЕСКД) и ГОСТ Р 2.105-2019 «ЕСКД. Общие требования к текстовым документам». Параметры для оформления текста в электронном виде.
7. Документирование программного обеспечения, программно-аппаратных изделий.
8. Создание векторных изображений и контроль ошибок в объемных документах.
9. Практикум. Оформление технической документации различного назначения. Стандартные и расширенные возможности текстового редактора MS Word и отечественного ПО. Настройка параметров программы для оформления технических документов. Формирование шаблона технического (конструкторского) документа: глобальные настройки документа; корректировка и добавление стилей; создание многоуровневой нумерованной структуры документа. Область навигации. Организация оглавления. Организация страничной структуры документа, содержащей рамки, основную надпись и дополнительные графы в соответствии с ГОСТ 2.104-2006. Обязательные и дополнительные структурные элементы текстовых документов. Правила оформления элементов текста. Вставка названий к таблицам и иллюстрациям. Организация перекрестных ссылок. Специальные поля в документе. Использование слияния для быстрого заполнения подготовленного бланка переменными данными, оформленными в виде таблицы. Защита документа от нежелательных изменений.
10. Программное обеспечение в работе технического писателя. HTML Help Workshop, средства Adobe, платформа DocBook/XML. Облачные технологии. Отечественное программное обеспечение для создания документации: аналоги Word и отечественные операционные системы, их отличия и лайфхаки.

Мастер-классы, практические занятия: создание технического документа. Структурирование информации при создании технической документации. Инфографика для визуализации научно-технической информации. Создание и оформление технического задания. Создание и оформление отчета. Создание и оформление руководства пользователя. Создание технического рекламного текста. Создание и документирование сценария использования хайтек-продукта. Разработка анкеты по изучению пользователей хайтек-продукта и др.