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

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

1. Профессиональный стандарт «Технический писатель». Актуализация требований к разработке технической документации.
2. Единые стандарты документирования. Требования национальных и межгосударственных стандартов к оформлению документации. Практические рекомендации и примеры оформления технических документов в соответствии с ГОСТ 34. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 к структуре и правилам составления отчетов. Управление документированной информацией в контексте требований ГОСТ Р ИСО 9001-2015.

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

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

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

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