02 docsvision
Click here to load reader
-
Upload
goudron1979 -
Category
Documents
-
view
1.098 -
download
1
Transcript of 02 docsvision
Внедрение технологии
единого источника
в компании - разработчике ПО
Елена ТолмачёваТехнический писатель 27.11.2014
www.docsvision.com Слайд: 2
Зачем вообще что-то
менять?
www.docsvision.com Слайд: 3
Наша документация просто ужасна!
www.docsvision.com Слайд: 4
Проблемы с выпуском документации
• Разрозненная документация
• Один документ в одном файле
• Сложности командной работы
• Текстовый редактор вместо специализированного ПО
• Невозможно повторно использовать контент
www.docsvision.com Слайд: 5
Почему технология единого источника?
• Много форматов из одного исходника (xhtml, chm, pdf и другие)
• Одновременная работа нескольких техписателей над одним проектом
• Повторное использование контента
www.docsvision.com Слайд: 6
Впереди нас ждет успех!
www.docsvision.com Слайд: 7
С чего же начать?
www.docsvision.com Слайд: 8
Что потребуется для перехода?
• Инструменты (выбор редактора для техписателя)
• Стандартизация (унификация комплекта документов)
• Дизайн (определение внешнего вида документов)
• Настройка (настройка Dita Open Toolkit)
• Хранение (хранение исходных файлов и сборок)
• Обучение (обучение команды техписателей)
www.docsvision.com Слайд: 9
Какие нужны специалисты?
• Дизайнер (подготовка макетов дизайна)
• Специалист отдела качества(стандартизация документации)
• Верстальщик (программист) (настройка тулкита)
• Техписатель (координатор работ специалистов, написание текста)
www.docsvision.com Слайд: 10
Итак, приступим к
делу!
www.docsvision.com Слайд: 11
Инструменты
www.docsvision.com Слайд: 12
Требуемые программы
www.docsvision.com Слайд: 13
Почему именно DITA?
• Использования любого редактора с поддержкой DITA
• Жестко определенная структура документа
• Унификация текста внутри раздела
• Компоновка итогового документа под конкретного Заказчика
www.docsvision.com Слайд: 14
Стандартизация
www.docsvision.com Слайд: 15
Стандарт документации компании
• Типы выпускаемых документов Руководство пользователя, администратора и т.д.
• Структуру выпускаемых документов Разделы документов
• Состав элементов структуры Наполнение разделов
www.docsvision.com Слайд: 16
Стандартизация состава элементов
www.docsvision.com Слайд: 17
Формат, локализация, нумерация
• Утверждение набора выходных форматов
• Определение необходимости локализации и набора языков
• Нумерация версий продукта и версий документа
www.docsvision.com Слайд: 18
Дизайн
www.docsvision.com Слайд: 19
Подготовка макетов дизайна
• Количество видов стилевого оформления
• Соответствие Style Guide
• Разработка макетов дизайна для каждого из выходных форматов (pdf, xhtml и тп)
• Утверждение макетов дизайна для каждого вида документа
www.docsvision.com Слайд: 20
www.docsvision.com Слайд: 21
www.docsvision.com Слайд: 22
Настройка
www.docsvision.com Слайд: 23
Настройка вывода
• Привлечение сторонних специалистов
• Настройка DITA OT для каждого из форматов вывода
• Тестирование настроек и решение проблем
www.docsvision.com Слайд: 24
Хранение
www.docsvision.com Слайд: 25
Сложность организации хранилища
• Необходимость разделения исходных файлов и готовых документов
• Создание репозитория, единого для всех техписателей
• Хранение исходных файлов для автосборки справок
• Хранение версий готовых документов
www.docsvision.com Слайд: 26
Хранение документации
www.docsvision.com Слайд: 27
Обучение
www.docsvision.com Слайд: 28
Сложности обучения техписателей
• Изменить мышление – переход с учебника на справочник
• Обучение работе в текстовом редакторе
• Изучение типового набора DITA тегов
• Подбор персонала
www.docsvision.com Слайд: 29
Что же в итоге?
www.docsvision.com Слайд: 30
Итоги
• Улучшение качества документации
• Увеличение скорости выпуска документов
• Уменьшение затрат
www.docsvision.com Слайд: 31
Теперь у нас отличная документация!
www.docsvision.com Слайд: 32
Вопросы?
Спасибо за внимание!
«ДоксВижн»
199155, Санкт-Петербург,
наб. р. Смоленки, д. 33
+7 (812) 335-35-15
+7 (812) 335-35-32www.docsvision.com
Елена Толмачева[email protected]