Технический писатель: создание технической документации. ИИ в работе технического писателя

Техническая документация и технический писатель: основные термины и понятия:

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

Профессиональный стандарт «Технический писатель»:

• Профессиональный стандарт «Технический писатель»: содержание, требования, применимость.

Виды технических текстов:

• Основные виды документов.
• Структура технического документа.
• Стиль текста и тон изложения.
• Язык технической документации.
• Упрощенный технический русский язык.
• Унификация текстовых формулировок.
• Терминология в технической документации.
• Лексические тонкости технического текста.

Средства, методы и приёмы создания технических текстов:

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

Разработка эксплуатационной документации:

• Целевая аудитория.
• Определение уровня разъяснения.
• Виды эксплуатационной документации.

Стандарты документирования:

• Назначение стандартов, отечественные и зарубежные стандарты.
• Зарубежные стандарты ИСО, система ГОСТ, другие стандарты.
• Унификация, стандартизация и нормоконтроль документирования.
• Оформление технических документов на базе шаблонов по ГОСТ.

Иллюстрации в технической документации:

• Визуализация и графическое сопровождение технических документов.
• Фотография и векторная иллюстрация в документах.

ПО в работе технического писателя:

• Средства MS Office. Возможности текстового редактора MS Word.
• Средства Adobe.
• Базовые форматы документации: PDF, DOC(X), HTML, LaTeX, RST.
• Облачные инструменты (Google Docs, R7, Опен Офис и др.).
• Системы документирования (Доктор Эксплейн, Документерра, Докузаурус и др.).
• Исправление ошибок в объемных документах.
• Контроль изменений, журнал ошибок/исправлений/изменений.
• Контроль версий (версионирование).

Нейросети в работе технического писателя:

• Работа с ИИ как компетенция технического писателя.
• Языковые модели, нейросети, агенты.
• Поиск и интерпретация информации, подготовка исходной версии документа, постредактирование, форматирование.
• Промпт-инжиниринг.
• Интеграция ИИ в MS Office и в процессе CI/CD. 

Разработка документации на основе принципа единого источника:

• Принцип единого источника.
• Особенности внедрения технологии DITA.

Процесс перевода технической документации (на примере английского языка):

• Упрощенный английский.
• Технический английский.
• Отраслевые варианты английского языка.
• Сложности перевода и локализации, подготовка текста к переводу.
• Особенности лексики, грамматики и синтаксиса технического английского.
• Руководство по стилю.
• Методы перевода технических текстов.
• Программное обеспечение переводчика.

Единая система конструкторской документации (ЕСКД).

Система разработки и постановки продукции на производство (СРПП).

• Роль и место технического писателя (ТП) в процессе подготовки технической документации (ТД) в рамках ГОСТ ЕСКД и СРПП.
• Задачи ТП. Обобщенные квалификационные требования. Основные формы работы ТП.
• ГОСТ ЕСКД - нормативная база работы ТП при подготовке ТД. Перечень действующих ГОСТ ЕСКД.
• Иные стандарты РФ, имеющие отношение к подготовке ТД. Система разработки и постановки продукции на производство (СРПП). 
• ГОСТ ЕСКД и ГОСТ ССРП.
• Назначение, область распространения стандартов ЕСКД. Общая структура стандартов ЕСКД ГОСТ 2.001.
• Назначение, область распространения стандартов СРПП. Общая структура стандартов СРПП, имеющих отношение к подготовке ТД. ГОСТ Р 15.000 и Р 15.201.
• Виды изделий по ГОСТ 2.101.
• Виды и комплектность конструкторских документов ГОСТ 2.102.
• Классификатор ЕСКД. Обозначения изделий ГОСТ 2.201.
• Оформление технической документации по ГОСТ Р 2.105 «ЕСКД. Общие требования к текстовым документам» и 2.106 «Текстовые документы».
• НИОКР. Требования к оформлению ТЗ на НИР по ГОСТ Р 15.101 и на ОКР по ГОСТ 15.016.
• ОКР. Техническое предложение по ГОСТ 2.118. Эскизный проект по ГОСТ 2.119. Технический проект по ГОСТ 2.119. Состав и подготовка технической документации.
• Технические условия по ГОСТ 2.114.
• Программы и методики испытаний по ГОСТ 2.106 и ГОСТ 15.309.
• Пояснительные записки по ГОСТ 2.106.
• Отчет о патентных исследованиях ГОСТ Р 15.011.
• Общие требования к эксплуатационной документации ГОСТ Р 2.601, ГОСТ Р 2.610. Руководство по эксплуатации. Паспорт. Формуляр.
• Общие требования к ремонтной документации ГОСТ 2.602. Техническая документация на средний ремонт. Техническая документация на капитальный ремонт.
• Подготовка ТД по ГОСТ 15.601. Техническое обслуживание и ремонт техники.
• Учет, хранение, обращение конструкторских документов и внесение изменений ГОСТ 2.501, ГОСТ Р 2.503.
• Требования ГОСТ 7.32 к структуре и правилам составления научно-технических отчетов.
• Требования к оформлению научно-технических публикаций в журналах ВАК и международных системах цитирования.

Определение и назначение стандартов ЕСПД. Область распространения стандартов ЕСПД:

• Классификация и обозначение стандартов ЕСПД.
• Стадии разработки программ и программной документации.
• Этапы и содержание работ. Техническое задание. Порядок построения и оформления.
• Пояснительная записка, требования к содержанию и оформлению.
• Структура обозначения программ и программных документов.
• Виды программных документов.
• Общие требования к оформлению программных документов. Основные надписи. 
• Требования к программным документам, выполненным печатным способом. Спецификация. 
• Текст программы. Программа и методика испытаний.

Единая система технологической документации (ЕСТД):

• Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
• ГОСТ Р 3.001-2023 ЕСТД. Общие положения.
• ГОСТ 3.1102-2011 «ЕСТД. Стадии разработки и виды документов. Общие положения».
• ГОСТ 3.1103-2011 «ЕСТД. Основные надписи. Общие положения».
• ГОСТ 3.1105-2011 «ЕСТД. Формы и правила оформления документов общего назначения».
• ГОСТ 3.1116-2011 «ЕСТД. Нормоконтроль».
• ГОСТ Р 59192-2020 «Электронная технологическая документация. Основные положения».