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

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

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

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

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

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

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

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

• Определение аудитории, группы читателей;
• Определение необходимого уровня разъяснения материала;
• Преодоление коммуникативных барьеров между разработчиком и потребителем продукта;
• Назначение технической документации: задачи пользователей;
• Метод сценариев (основы проектирования опыта взаимодействия для определения содержания технических документов);
• Практический опыт взаимодействия технического писателя и технического специалиста (SME) при сборе информации;
• Аналитическая переработка текста в техническом писательстве;
• Создание плана: интеллектуальное картирование, структура технического текста;
• Разработка эксплуатационной документации:
  • Упрощенный технический русский язык;
  • Унификация текстовых формулировок;
• Терминология в технической документации: правила применения единых терминов;
• Лексические тонкости в технических документах;
• Методы копирайтинга в техническом писательстве (статья, реклама);
• Техническое аннотирование и реферирование;
• Оформление цитирования.

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

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

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

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

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

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

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

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

Взаимодействие технических подразделений с техническими писателями. Организация подразделения технических писателей.

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

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

Определение и назначение стандартов ЕСПД. Область распространения стандартов ЕСПД. Классификация и обозначение стандартов ЕСПД. ГОСТ 19.001:

• Понятие программной документации.
• Группы стандартов ЕСПД.
• Виды программных документов (ГОСТ 19.101).
• Обозначение программ и программных документов (ГОСТ 19.103).
• Основные надписи (ГОСТ 19.104).
• Общие требования к оформлению программных документов.
• Требования к программным документам, выполненным печатным способом (ГОСТ 19.105, ГОСТ 19.106).

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

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

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

• Оформление текста и таблиц по ГОСТ Р 2.105-2019 «ЕСКД. Общие требования к текстовым документам». Параметры для оформления текста в электронном виде.
• Назначение, область распространения стандартов ЕСКД. Общая структура стандартов ЕСКД ГОСТ 2.001.
• Классификатор ЕСКД. Обозначения изделий ГОСТ 2.201.
• Виды и комплектность конструкторских документов ГОСТ 2.102
• Нормоконтроль. Цели, задачи, содержание и порядок проведения. ГОСТ 2.111.
• Общие требования к оформлению, изложению и построению текстовых документов. ГОСТ Р 2.105.

Общие требования к эксплуатационной документации ГОСТ Р 2.601, ГОСТ Р 2.610:

• Учет, хранение, обращение конструкторских документов и внесение изменений ГОСТ 2.501–2013, ГОСТ 2.503–2013.