Разработка и оформление технической документации с учетом требований национальных и межгосударственных стандартов

О курсе:

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

Для кого:

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

Программа:

1. Требования стандартов ГОСТ, ГОСТ Р, ГОСТ РВ к разработке документации. Нормативные требования к содержанию и оформлению технической документации предприятия. Структура документирования и виды документов.
2. Практические рекомендации и примеры оформления технических документов. Разработка шаблонов документов различного назначения: технические условия, технологический регламент, технологическая инструкция, руководство по эксплуатации.
   • Разработка и оформление технического задания (ТЗ). Формализация требований и написание ТЗ для разработчиков. Переговоры с проектировщиками, подрядчиками и поставщиками. Оформление ТЗ. Стандарт оформления ТЗ по ГОСТ 34.602-2020 «Техническое задание на создание автоматизированной системы», ГОСТ 2.105, ГОСТ 2.301.
   • Разработка технических условий (ТУ) в соответствии с ГОСТ 2.114-2016.
   • Оформление руководства пользователя в соответствии с ГОСТ 34.201-2020.
   • Правила оформления и комплектования эксплуатационных документов по ГОСТ 2.601-2013, ГОСТ Р 2.610-2019 «ЕСКД. Правила выполнения эксплуатационных документов».
   • Сложности написания руководства пользователя по ГОСТ. Обязательные разделы документа «Руководство пользователя» (ГОСТ 34). Пояснения по их содержанию. Оформление титульных листов, аннотации и содержания. Параметры печатных страниц документа и расположение основных элементов на них. Структура и оформление колонтитулов. Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы. Формирование и оформление заголовков, разделов, перечислений (списков).
   • Оформление конструкторской документации. Параметры оформления по ГОСТ 2 серии. ГОСТ Р 2.102-2023 «Единая система конструкторской документации» (ЕСКД). Оформление текста по ГОСТ Р 2.105-2019 (с изменениями) «ЕСКД. Общие требования к текстовым документам». Параметры для оформления текста в электронном виде. Правила оформления таблиц. Требования к выполнению элементов иллюстраций (схем, графиков, фотографий, рисунков). Установление связи иллюстраций с текстом. Оформление по ГОСТ 2.106-2019 «ЕСКД. Текстовые документы». Формы и правила выполнения конструкторских документов. Шаблон оформления рамок документа. Требования ГОСТ Р 2.104-2023 к основным надписям.
3. Техническое документирование. Этапы создания технического текста. Структурирование информации при создании технического документа. Создание плана технического текста: интеллектуальное картирование, определение структуры текста. Виды логических структур. Пирамида идей. Анализ информации: работа с источниками. Техническое аннотирование и реферирование. Оформление цитирования. Навыки, необходимые создателю технической документации. Читаемый текст: функциональность стиля, информативность и дизайн. Понятие информативности технического текста. Виды функциональных стилей в технической коммуникации. Использование упрощенного технического языка. Информационный стиль.Информационный дизайн технического документа.
4. Искусственный интеллект (ИИ) в создании технической документации: промты, форматирования технических текстов программного кода, создание изображений и инфографики. Модели ИИ для создания документации.
5. Требования ГОСТ 7.32-2017 к структуре и правилам составления отчетов о научно-исследовательских, проектно-конструкторских, конструкторско-технологических и проектно-технологических работах.
6. Правила внесения изменений в конструкторскую документацию (КД) и технологическую документацию (ТД). Правила производства и приемки продукции в условиях изменений, вносимых в КД. Порядок подтверждения вносимых в КД и ТД изменений.
7. Оформление документации в соответствии с национальными и международными стандартами по экологии, качеству и профтехбезопасности.
8. Корректировка рабочей конструкторской документации (РКД) для организации промышленного (серийного) производства оборонной продукции. Контроль и учет внесения изменений в документацию на изделия ВВСТ; Контроль порядка разработки, комплектации, оформления и обращения технологической документации, применяемой при изготовлении и ремонте ВВСТ.
9. Практикум. Оформление технической документации различного назначения с использованием стандартных и расширенных возможностей текстового редактора MS Word. Формирование шаблона технического (конструкторского) документа: глобальные настройки документа; корректировка и добавление стилей; создание многоуровневой нумерованной структуры документа. Область навигации. Организация оглавления. Организация страничной структуры документа, содержащей рамки, основную надпись и дополнительные графы в соответствии с ГОСТ Р 2.104-2023. Обязательные и дополнительные структурные элементы текстовых документов. Правила оформления элементов текста: перечислений, таблиц, графических материалов, формул, примечаний, сносок, примеров. Особенности организации перекрестных ссылок. Специальные поля в документе. Регулярные выражения. Использование слияния для быстрого заполнения подготовленного бланка переменными данными, оформленными в виде таблицы. Защита документа от нежелательных изменений.
10. Построение делового взаимодействия. Способы преодоления барьеров технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем.