02 docsvision

Внедрение технологии

единого источника

в компании - разработчике ПО

Елена ТолмачёваТехнический писатель 27.11.2014

www.docsvision.com Слайд: 2

Зачем вообще что-то

менять?


Наша документация просто ужасна!


Проблемы с выпуском документации

• Разрозненная документация

• Один документ в одном файле

• Сложности командной работы

• Текстовый редактор вместо специализированного ПО

• Невозможно повторно использовать контент


Почему технология единого источника?

• Много форматов из одного исходника (xhtml, chm, pdf и другие)

• Одновременная работа нескольких техписателей над одним проектом

• Повторное использование контента


Впереди нас ждет успех!


С чего же начать?


Что потребуется для перехода?

• Инструменты (выбор редактора для техписателя)

• Стандартизация (унификация комплекта документов)

• Дизайн (определение внешнего вида документов)

• Настройка (настройка Dita Open Toolkit)

• Хранение (хранение исходных файлов и сборок)

• Обучение (обучение команды техписателей)


Какие нужны специалисты?

• Дизайнер (подготовка макетов дизайна)

• Специалист отдела качества(стандартизация документации)

• Верстальщик (программист) (настройка тулкита)

• Техписатель (координатор работ специалистов, написание текста)


Итак, приступим к

делу!


Инструменты


Требуемые программы


Почему именно DITA?

• Использования любого редактора с поддержкой DITA

• Жестко определенная структура документа

• Унификация текста внутри раздела

• Компоновка итогового документа под конкретного Заказчика


Стандартизация


Стандарт документации компании

• Типы выпускаемых документов Руководство пользователя, администратора и т.д.

• Структуру выпускаемых документов Разделы документов

• Состав элементов структуры Наполнение разделов


Стандартизация состава элементов


Формат, локализация, нумерация

• Утверждение набора выходных форматов

• Определение необходимости локализации и набора языков

• Нумерация версий продукта и версий документа


Дизайн


Подготовка макетов дизайна

• Количество видов стилевого оформления

• Соответствие Style Guide

• Разработка макетов дизайна для каждого из выходных форматов (pdf, xhtml и тп)

• Утверждение макетов дизайна для каждого вида документа




Настройка


Настройка вывода

• Привлечение сторонних специалистов

• Настройка DITA OT для каждого из форматов вывода

• Тестирование настроек и решение проблем


Хранение


Сложность организации хранилища

• Необходимость разделения исходных файлов и готовых документов

• Создание репозитория, единого для всех техписателей

• Хранение исходных файлов для автосборки справок

• Хранение версий готовых документов


Хранение документации


Обучение


Сложности обучения техписателей

• Изменить мышление – переход с учебника на справочник

• Обучение работе в текстовом редакторе

• Изучение типового набора DITA тегов

• Подбор персонала


Что же в итоге?


Итоги

• Улучшение качества документации

• Увеличение скорости выпуска документов

• Уменьшение затрат


Теперь у нас отличная документация!


Вопросы?

Спасибо за внимание!

«ДоксВижн»

199155, Санкт-Петербург,

наб. р. Смоленки, д. 33

+7 (812) 335-35-15

+7 (812) 335-35-32www.docsvision.com

Елена Толмачева[email protected]

http://www.docsvision.com/

02 docsvision

Documents