Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Возможности инструментов для публикации из единого источника (Павел Семёнов)

Возможности инструментов для публикации из единого источника (Павел Семёнов)

http://docfactor.ru.

4 ноября 2016, Новосибирск

Возможности инструментов для публикации из единого источника (Павел Семёнов, Сбертех, Новосибирск).

Видеозапись: https://www.youtube.com/watch?v=5OqZSXC5cEM

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

DocFactor — конференция о технической документации и ее роли в разработке ПО.

Подробнее: http://docfactor.ru

More Decks by DocFactor: конференция о технической документации

Other Decks in Education

Transcript

  1. Возможности инструментов для
    публикации из единого источника
    Павел Семёнов
    DocFactor
    4 ноября 2016 г.
    Новосибирск

    View Slide

  2. Принцип единого источника
    Содержимое создаётся и хранится в одном месте –
    источнике, а затем публикуется в различных форматах и
    комбинациях.

    View Slide

  3. Сопутствующие принципы
     Структурирование содержимого (Structured authoring)
    Отделяет содержание от представления
     Разделение на топики (Topic-based writing)
    Позволяет авторам переиспользовать содержимое, а
    читателям - быстро находить решения отдельных задач

    View Slide

  4. Зачем?
     Стоимость:
     Экономия при создании
     «Бесплатные» каналы распространения
     Консистентность:
     Простота обновления
     Простота исправления

    View Slide

  5. Инструменты
     Desktop:
     Help+Manual
     MadCap Flare
     Dr.Explain
     Adobe RoboHelp
     Server:
     AuthorIT
     Online/Cloud:
     AuthorIT Cloud
     HelpServer
    • Неспециализированные:
    • MS Word & Co
    • Wiki
    • Atlassian Confluence
    Help Authoring Tool -
    HAT

    View Slide

  6. Мультиформатная публикация
     Создание содержимого в визуальном редакторе
     Настройка форматов публикации

    View Slide

  7. Разделение содержимого и представления
     Cтруктурирование содержимого
     Исходный текст содержит метаданные (стили)
     Внешний вид документа определяется шаблоном публикации

    View Slide

  8. Разделение содержимого и структуры документа
     Разделение на топики
     Топик включается или исключается из профиля публикации
     Документ формируется из заданных топиков.
    Changing
    Your
    Password
    User’s Guide
    Administrator’s
    Guide

    View Slide

  9. Параметризация содержимого
     Переменные: присваиваем значение один раз, изменяем
    все вхождения одновременно
     Применение:
     Названия продуктов
     Номера версий
     Повторяющийся текст: примечания, предупреждения и т.д.
     Оформление:
    , %CURRENT_VERSION%, …

    View Slide

  10. Командная работа
     Одновременная работа: использование VCS или
    встроенных инструментов
     Ролевая модель:
    Авторы
    Редакторы
    Переводчики
    Администраторы

    View Slide

  11. Другие функции
     Управление локализацией
     Интеграция с системами контроля версий
     Специализированные графические и видеоредакторы
     Статический анализ проекта
     Статический анализ текста

    View Slide

  12. Автоматизация создания документации
     Создание индексов, инструментов поиска и навигации
     Автогенерация страниц с описанием интерфейса по
    снимку экрана
     Автогенерация инструкций по движениям курсора и
    изменениям изображения

    View Slide

  13. Обратная сторона
     Стоимость инструментов
     Обучение авторов
     Перенастройка процесса

    View Slide

  14. Критерии применимости
     Необходимость разных форматов
     Длительный жизненный цикл
     Набор документов (возможно, изменяющийся)
     Ориентированность на читателя
     Необходимость переводов
     Командная работа

    View Slide

  15. Спасибо за внимание
    [email protected]

    View Slide