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

    Для кого

    для специалистов, ответственных за разработку и сопровождение технической документации, технических писателей, 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).

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