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

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

1. Профессиональный стандарт «Технический писатель», изменения введенные в действие с 1 марта 2023 г.Актуализация требований к разработке технической документации.
2. Единые стандарты документирования. Требования национальных и межгосударственных стандартов к оформлению документации. Практические рекомендации и примеры оформления технических документов в соответствии с ГОСТ 34. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 к структуре и правилам составления отчетов. Управление документированной информацией в контексте требований ГОСТ Р ИСО 9001-2015.
   Мастер-класс: Оформление ТЗ по ГОСТ 34.602-2020. Создание и оформление руководства пользователя, технических условий.
3. Методы и приемы работы с техническими текстами. Методы аналитико-синтетической переработки, используемые в техническом писательстве. Этапы создания технического текста. Изучение целевой аудитории: метод сценариев. Создание плана технического текста: интеллектуальное картирование, определение структуры текста. Техническое аннотирование и реферирование. Оформление цитирования. Читабельный текст: функциональность стиля, информативность и дизайн. Виды функциональных стилей в технической коммуникации. Терминология в технической документации. Информационный дизайн технического документа. Визуализация информации и применение инфографики в техническом документе. Особенности создания и использования деловой графики.
   Мастер-классы: структурирование информации при создании технической документации. Создание инфографики для визуализации научно-технической информации.
4. Техническая коммуникация и техническое писательство. Особенности технического документирования. Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления. Навыки, необходимые техническому писателю. Формат и структура технического документа. Методы копирайтинга научно-технической рекламы, используемые в техническом писательстве.
5. Разработка документации на основе принципа единого источника. Стандарт DITA. Особенности внедрения технологии DITA на предприятии, целесообразность использования XML-подобных документов. Разработка структурированного контента разных типов, смысловая разметка документов, формирование документа. Применение инструментария Oxygen.
   Практикум.
6. Принципы создания технических текстов. Целевое назначение технической документации: определение целей обращения пользователей к техническим документам. Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов. Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации.
7. Оформление текста и таблиц по ГОСТ Р 2.105-2019 «ЕСКД. Общие требования к текстовым документам». Параметры для оформления текста в электронном виде.
8. Документирование программного обеспечения, программно-аппаратных изделий. Предмет документирования: программный продукт, документация пользователя и ее характеристики. Документы, используемые при эксплуатации программного продукта.
9. Создание векторных изображений и контроль ошибок в объемных документах. Векторные изображения в документе. Методика отрисовки векторной графики в PowerPoint. Контроль ошибок в объемных документах. Базовые процессы по контролю документации. Страхи при написании объемной документации. Версионирование. Системы баг-трекинга ПО — помощники технического писателя. Организация контроля за ошибками и доработками в документах. WIKI-системы платные и бесплатные. Примеры интересных ресурсов по документации.
10. Практикум. Оформление технической документации различного назначения. Стандартные и расширенные возможности текстового редактора MS Word и отечественного ПО. Настройка параметров программы для оформления технических документов. Формирование шаблона технического (конструкторского) документа: глобальные настройки документа; корректировка и добавление стилей; создание многоуровневой нумерованной структуры документа. Область навигации. Организация оглавления. Организация страничной структуры документа, содержащей рамки, основную надпись и дополнительные графы в соответствии с ГОСТ 2.104-2006. Обязательные и дополнительные структурные элементы текстовых документов. Правила оформления элементов текста. Вставка названий к таблицам и иллюстрациям. Особенности организации перекрестных ссылок. Специальные поля в документе. Регулярные выражения. Использование слияния для быстрого заполнения подготовленного бланка переменными данными, оформленными в виде таблицы. Защита документа от нежелательных изменений.
11. Программное обеспечение в работе технического писателя. HTML Help Workshop, средства Adobe, платформа DocBook/XML. Облачные технологии. Архитектура типизированной информации Darwin.
    Практика: ознакомление с возможностями отдельных программных комплексов.