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

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

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

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

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

• Отечественные и зарубежные стандарты.
• Классификация ГОСТов.
• Зарубежные стандарты ИСО в области системной и программной инженерии.
• Назначение стандартов.
• ГОСТ 7.32-2001.
• Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам.
• Система стандартов ГОСТ 19 и ГОСТ 34.
• Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД).
• Система стандартов по информации, библиотечному и издательскому делу (СИБИД).
• Единая система конструкторской документации (ЕСКД).
• Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов.
• Управление документированной информацией в контексте требований МС ISO 9001:2015.

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

• Формат и структура технического документа: отчёт, ТЗ, ТП, статья: общие черты и различия.
• Стили технической документации.

Средства и методы создания технических текстов.

• Блок целеполагания: цель, задачи, методы и средства.
• Определение аудитории и уровня разъяснения материала.
• Об описании БД, кодов. Создание руководств пользователя.
• ПРАКТИКА: Корректировка имеющихся текстов: основы редактирования и корректуры.

Приёмы работы с техническими текстами.

• Терминология в технической документации: правила применения единых терминов.
• Визуализация и графическое сопровождение технических документов.
• Работа над ошибками и лексические тонкости в технических документах.

Создание векторных изображений и контроль ошибок в объемных документах.

• Векторные изображения в документе.
• Иллюстрации в MS Word.
• Фотография и векторная иллюстрация в документах.
• Методика отрисовки векторной графики в PowerPoint.
• Специальная вставка изображений в MS Word.
• Контроль ошибок в объемных документах.
• Базовые процессы по контролю документации.
• Версионирование. Системы баг-трекинга ПО — помощники технического писателя.
• Организация контроля за ошибками и доработками в документах.

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

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

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

• Базовые форматы документации: HTML, DOC(X), CHM, PDF.
• HTML Help Workshop.
• Средства MS Office.
• Средства Adobe.
• Платформа DocBook/XML.
• Wiki-системы.
• Облачные технологии (Google Docs, Evernote, Dropbox и др.).
• Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin.