Курс Технический писатель

для профессионалов, ответственных за разработку и сопровождение технической документации, технических писателей, IT-специалистов

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

1. Способы и приемы работы с техническими текстами. Способы аналитико-синтетической переработки, применяемые в техническом писательстве. Способы сотворения понятных текстов. Визуализация инфы в технических документах. Достоинства зрительной коммуникации. Особенности сотворения отдельных видов технических документов.
2. Техно коммуникация и техническое писательство. Особенности технического документирования. Информационные барьеры технической коммуникации. Способности, нужные техническому писателю. Формат и структура технического документа. Стили технической документации.
3. Единые эталоны документирования. Практические советы и примеры дизайна технических документов на базе шаблонов, составленных по эталонам ГОСТ, ISO, ITU, IEEE в области сотворения и управления документацией. Единый эталон программной документации (ЕСПД). Система эталонов по инфы, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД).
4. Принципы сотворения технических текстов. Способ сценариев и базы проектирования опыта взаимодействия для определения содержания технических документов. Способы копирайтинга научно-технической рекламы, применяемые в техническом писательстве.
5. Промышленный подход к разработке документации на основе принципа единого источника (DITA, Oxygen).
6. Документация, ориентированная на пользователя: Help и online-справка (Robohelp, Confluence). Формирование справки при помощи Robohelp.
7. Создание профессиональных справочных файлов.
8. Документирование аппаратных устройств, программно-аппаратных изделий.
9. Документирование программного обеспечения. Предмет документирования: программный продукт, документация пользователя и ее характеристики. Документы, используемые при эксплуатации программного продукта. Стандарты как методология разработки программного обеспечения и документации (ГОСТы, ISO).
10. Перевод технической документации. Сложности перевода на другой язык, основные подводные камни.
11. Инструменты, используемые техническими писателями. Текстовые редакторы, компоненты издательских систем. Традиционный подход к созданию комплекта документации. Особенности использования программ Microsoft Word, Adobe Acrobat.
12. Программное обеспечение в работе технического писателя. Базовые форматы документации: HTML, DOC(X), CHM, PDF. HTML Help Workshop. Средства MS Office. Средства Adobe. Платформа DocBook/XML. Облачные технологии (Google Docs, Evernote, Dropbox и др.). Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin (Darwin Information Typing Architecture, DITA) .

Мастер — классы: Создание технического документа. Структурирование информации при создании технической документации. Создание инфографики для визуализации научно-технической информации. Создание и оформление технического задания. Создание и оформление отчета. Создание и оформление руководства пользователя.
Мастер — классы: Создание технического рекламного текста. Создание и документирование сценария использования хайтек продукта. Разработка анкеты по изучению пользователей хайтек продукта. Популяризация научно-технического текста.
Практика: ознакомление с возможностями отдельных программных комплексов.
Разработка документации на основе принципа единого источника (DITA, Oxygen).

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

1. Техническая коммуникация и техническое писательство. Особенности технического документирования. Информационные барьеры технической коммуникации между разработчиком высокотехнологичного продукта и его потребителем и возможности их преодоления. Навыки, необходимые техническому писателю. Формат и структура технического документа. Стили технической документации. Методы копирайтинга научно-технической рекламы, используемые в техническом писательстве. Принципы популяризации научно-технического текста.
2. Единые стандарты документирования. Практические рекомендации и примеры оформления технических документов на базе шаблонов, составленных по стандартам. Система стандартов ГОСТ 19 и ГОСТ 34. Унификация, стандартизация и нормоконтроль документирования. Единый стандарт программной документации (ЕСПД). Система стандартов по информации, библиотечному и издательскому делу (СИБИД). Единая система конструкторской документации (ЕСКД). Единая система технологической документации (ЕСТД). Управление документированной информацией в контексте МС ISO 9001:2017.
3. Принципы создания технических текстов. Целевое назначение технической документации: определение целей обращения пользователей к техническим документам. Метод сценариев и основы проектирования опыта взаимодействия для определения содержания технических документов. Практический опыт взаимодействия технического писателя и технического специалиста при сборе информации. Мастер — класс: Создание научно-технического рекламного текста.
4. Промышленный подход к разработке документации на основе принципа единого источника.
5. Документация, ориентированная на пользователя: Help и online-справка. Confluence. Создание профессиональных справочных файлов. Формирование справки при помощи Robohelp.
6. Документирование программного обеспечения, программно-аппаратных изделий. Предмет документирования: программный продукт, документация пользователя и ее характеристики. Документы, используемые при эксплуатации программного продукта.
7. Перевод технической документации. Сложности перевода на другой язык, основные подводные камни.
8. Секреты мастерства. Инструменты, используемые техническими писателями. Текстовые редакторы, компоненты издательских систем. Microsoft Word: использование расширенных возможностей. Шаблоны, применение и создание стилей. Сложные документы. Формирование названий и объектов сносок; перекрестных ссылок, оглавления, предметного указателя; списка литературы. Макетирование. Программное обеспечение в работе технического писателя. HTML Help Workshop. Средства Adobe. Платформа DocBook/XML. Облачные технологии (Google Docs, Evernote, Dropbox и др.). Программное обеспечение создания презентаций и инфографики. Wiki-системы. Архитектура типизированной информации Darwin. Практика: ознакомление с возможностями отдельных программных комплексов.