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

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

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

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

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

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

• Основные виды документов.
• Формат и структура технического документа.
• Стили технической документации.

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

• Назначение технической документации.
• Определение аудитории, группы читателей.
• Читатель и текст: нейробиологический и психолингвистический аспекты.
• Преодоление коммуникативных барьеров между разработчиком и читателем/пользователем.
• Определение уровня разъяснения: руководство пользователя vs. руководство администратора/оператора.
• Стиль текста и тон изложения.
• Метод сценариев: картирование опыта, дизайн, план и структура технического документа.
• Практика взаимодействия технического писателя и технического специалиста (SME).
• Аналитическая переработка текста в техническом писательстве.

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

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

Техническое аннотирование и реферирование.

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

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

Оформление технической документации различного назначения:

• Визуализация и графическое сопровождение технических документов.
• Фотография и векторная иллюстрация в документах.
• Отображение алгоритма или процесса с помощью блок-схем.
• Документирование функциональных требований (ФТ).

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

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

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

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

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

• Технический английский.
• Упрощенный английский.
• Отраслевые варианты английского языка.
• Сложности перевода на другой язык, основные подводные камни.
• Грамматика и лексика в техническом переводе, особенности пунктуации (закрытый и открытый стиль), значение «руководств по стилю».
• Правила и способы перевода технических текстов.
• Применяемое программное обеспечение и приёмы его корректного использования.
• Понятие локализации в технических переводах.

Перевод и редактирование технического текста.

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

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

• Роль и место технического писателя (ТП) в процессе подготовки технической документации (ТД) в рамках ГОСТ ЕСКД и СРПП.
• Задачи ТП. Обобщенные квалификационные требования. Основные формы работы ТП.
• ГОСТ ЕСКД - нормативная база работы ТП при подготовке ТД. Перечень действующих ГОСТ ЕСКД.
• Иные стандарты РФ, имеющие отношение к подготовке ТД. Система разработки и постановки продукции на производство (СРПП).
• ГОСТ ЕСКД и ГОСТ ССРП.
• Назначение, область распространения стандартов ЕСКД. Общая структура стандартов ЕСКД ГОСТ 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 «Электронная технологическая документация. Основные положения».