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

Программа курса направлена на подготовку специалистов в области разработки технической документации. Благодаря освещению в рамках курса самых актуальных теоретических вопросов технического писательства и закреплению навыков на практике, слушатели научатся писать технические тексты, следовать правилам и применять существующие стандарты документирования. Курс предназначен для: Технических писателей; сотрудников, ответственных за разработку и сопровождение технической документации; руководителей и технических специалистов; всех заинтересованных лиц, с опытом работы в IT – сфере или имеющих техническое образование. Цели курса: -Получить знания методик и приемов подготовки технической документации; -Применять существующие стандарты документирования; -Использовать программные инструменты для технических писателей; -Грамотно вести переговоры с техническими специалистами; -Разрабатывать различные виды технических документов. В программе: Техническая документация и технический писатель: основные термины и понятия. Введение в проблему: • Профессиональный стандарт «Технический писатель»: содержание и требования. • Содержание работы технического писателя. Отличия технического писателя от обычного писателя и от писателя-аналитика. • Виды занятости, связанные с разработкой документации и основные виды создаваемых документов. • Навыки и умения, необходимые техническому писателю. • Задачи технического писателя. Группы читателей. • Варианты занятости и сферы деятельности технического писателя. • Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления. Единые стандарты документирования: • Отечественные и зарубежные стандарты. • Классификация ГОСТов. • Зарубежные стандарты ИСО в области системной и программной инженерии. • Назначение стандартов. • ГОСТ 7.32-2017. • Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам. • Система стандартов ГОСТ 19 и ГОСТ 34. • Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). • Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). • Оформление текста и таблиц по ГОСТ Р 2.105-2019 «ЕСКД. Общие требования к текстовым документам». Параметры для оформления текста в электронном виде. • Назначение, область распространения стандартов ЕСКД. Общая структура стандартов ЕСКД ГОСТ 2.001. • Классификатор ЕСКД. Обозначения изделий ГОСТ 2.201. • Виды и комплектность конструкторских документов ГОСТ 2.102 • Нормоконтроль. Цели, задачи, содержание и порядок проведения. ГОСТ 2.111. • Общие требования к оформлению, изложению и построению текстовых документов. ГОСТ Р 2.105. Общие требования к эксплуатационной документации ГОСТ Р 2.601, ГОСТ Р 2.610. • Учет, хранение, обращение конструкторских документов и внесение изменений ГОСТ 2.501–2013, ГОСТ 2.503–2013. Определение и назначение стандартов ЕСПД. Область распространения стандартов ЕСПД. Классификация и обозначение стандартов ЕСПД. ГОСТ 19.001. • Виды программных документов ГОСТ 19.101. • Обозначение программ и программных документов ГОСТ 19.103. • Основные надписи ГОСТ 19.104. • Общие требования к оформлению программных документов. Требования к программным документам, выполненным печатным способом. ГОСТ 19.105, ГОСТ 19.106. Единая система технологической документации (ЕСТД). Требования ГОСТ 7.32-2017 (введен 01.07.2018) к структуре и правилам составления отчетов. • ГОСТ 3.1001-2011 «ЕСТД. Общие положения». • ГОСТ 3.1102-2011 «ЕСТД. Стадии разработки и виды документов. Общие положения». • ГОСТ 3.1103-2011 «ЕСТД. Основные надписи. Общие положения». • ГОСТ 3.1105-2011 «ЕСТД. Формы и правила оформления документов общего назначения». • ГОСТ 3.1116-2011 «ЕСТД. Нормоконтроль». • ГОСТ Р 59192-2020 «Электронная технологическая документация. Основные положения». • Управление документированной информацией в контексте требований МС ISO 9001:2015. • Практика: Оформление ТЗ по ГОСТ 34.602-2020. Создание и оформление руководства пользователя, технических условий. Виды и стили технических текстов: • Особенности технического документирования. • Формат и структура технического документа (отчёт, ТЗ, ТП, статья: общие черты и различия). • Стили технической документации. • Разработка эксплуатационной документации: o упрощенный технический русский язык; o требования по унификации текстовых формулировок. • Методы копирайтинга научно-технической рекламы, используемые в техническом писательстве. Принципы создания технических текстов: • Целевое назначение технической документации: определение целей обращения пользователей к техническим документам. • Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов. • Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации. Разработка документации на основе принципа единого источника. Стандарт DITA: • Особенности внедрения технологии DITA на предприятии, целесообразность использования XML-подобных документов. • Разработка структурированного контента разных типов, смысловая разметка документов, формирование документа. Средства и методы создания технических текстов: • Методы аналитико-синтетической переработки, используемые в техническом писательстве. • Определение аудитории и уровня разъяснения материала. • Создание плана технического текста: интеллектуальное картирование, определение структуры текста. Техническое аннотирование и реферирование. • Оформление цитирования. Приёмы работы с техническими текстами: • Терминология в технической документации: правила применения единых терминов. • Визуализация и графическое сопровождение технических документов. • Работа над ошибками и лексические тонкости в технических документах. • Практика: Корректировка имеющихся текстов: основы редактирования и корректуры. Создание векторных изображений и контроль ошибок в объемных документах: • Векторные изображения в документе. • Иллюстрации в MS Word. • Фотография и векторная иллюстрация в документах. • Методика отрисовки векторной графики в PowerPoint. • Специальная вставка изображений в MS Word. • Контроль ошибок в объемных документах. • Базовые процессы по контролю документации. • Версионирование. Системы баг-трекинга ПО — помощники технического писателя. • Организация контроля за ошибками и доработками в документах. Оформление технической документации различного назначения: • Стандартные и расширенные возможности текстового редактора MS Word и отечественного ПО. • Настройка параметров программы для оформления технических документов. • Формирование шаблона технического (конструкторского) документа: глобальные настройки документа; корректировка и добавление стилей; создание многоуровневой нумерованной структуры документа. • Область навигации. Организация оглавления. Организация страничной структуры документа, содержащей рамки, основную надпись и дополнительные графы в соответствии с ГОСТ 2.104-2006. • Обязательные и дополнительные структурные элементы текстовых документов. Правила оформления элементов текста. • Вставка названий к таблицам и иллюстрациям. Особенности организации перекрестных ссылок. • Специальные поля в документе. Регулярные выражения. • Использование слияния для быстрого заполнения подготовленного бланка переменными данными, оформленными в виде таблицы. • Защита документа от нежелательных изменений. Процесс перевода технической документации (на примере английского языка): • Сложности перевода на другой язык, основные подводные камни. • Грамматика и лексика в техническом переводе. • Правила и способы перевода технических текстов. • Применяемое программное обеспечение и приёмы его корректного использования. • Понятие локализации в технических переводах. • Практика: Перевод и редактирование технического текста. Программное обеспечение в работе технического писателя: • Базовые форматы документации: HTML, DOC(X), CHM, PDF. • HTML Help Workshop. • Средства MS Office. • Средства Adobe. • Платформа DocBook/XML. • Wiki-системы платные и бесплатные. Примеры интересных ресурсов по документации. • Облачные технологии (Google Docs, Evernote, Dropbox и др.). • Программное обеспечение создания презентаций и инфографики. • Архитектура типизированной информации Darwin. • Практика: Ознакомление с возможностями отдельных программных комплексов. Преподаватели: Преподаватели курсов по техническому копирайтингу. Эксперты по составлению технической документации. Условия участия: При единовременном участии двух и более сотрудников в одном мероприятии предоставляется скидка - 7 %. В стоимость обучения входит: Методический материал, кофе-паузы. Иногородним клиентам оказывается помощь в бронировании гостиницы на период прохождения обучения.