Мероприятие находится в архиве, регистрация закрыта

Курс повышения квалификации

Код 39381

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

    Для кого

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

    Программа

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