Главная
Форум
Лаборатория технического писателя
"Единый источник" документации
Практические примеры использования Docbook, DITA в компаниях.

Практические примеры использования Docbook, DITA в компаниях.

Внимание! У нас сбои с почтовым сервером! Если не пришло письмо о регистрации или смене пароля напишите нам на info@techwriters.ru!
@twriters чат для технических писателей в Telegram

Зарегистрируйтесь

RSS

Практические примеры использования Docbook, DITA в компаниях., Примеры использования Docbook, DITA.

Leonid

Не определившийся

Сообщений: 2 Баллов: 1 Рейтинг: 6 Авторитет: 6 Регистрация: 24.04.2014

Мне нравится0

24.04.2014 16:17:32

Здравствуйте, уважаемые специалисты по технической документации.

На форуме прочитал большое количество сообщений о технологиях XML (Docbook, DITA).

Могли бы Вы привести примеры использования технологий XML (Docbook, DITA) при разработке документации в Ваших компаниях:
- Какие типы документов выпускаете с помощью этих технологий?
- В каких форматах?
- Какие инструменты для этого используете?

ADVANCED

Эксперт

Сообщений: 1782 Баллов: 1965 Рейтинг: 1 Авторитет: 1 Регистрация: 07.07.2010

Мне нравится0

25.04.2014 10:28:12

Отвечу за себя

Цитата
Leonid пишет: Какие типы документов выпускаете с помощью этих технологий?

Руководство пользователя, Администратора, контектная справка, однотипные ТЗ, ПМИ, Спецификации, документы типа "Что нового" и т.п.

Цитата
Leonid пишет: В каких форматах?

PDF, DOC (и RTF), DOCX, ODT, ePub, CHM (без проблем с кириллицей и с нормальным поиском), XHTML (статические сайты любой сложности с поиском), Confluence, docuwiki, WebHelp (с применением JS и поиском).

Цитата
Leonid пишет: Какие инструменты для этого используете?

XMLMind Editor Personal Edition 5.3.0 (уже не поддерживается в качестве постоянного использования, помоему только триал на 30 дней, но могу дать)
PSPad Editor - редактор для правки текстовых файлов, автозамены, работы с RegExp и т.п. не портин кодировку файлов в винде
Apache Ant >1.9.2. - сборщик и обработчик скриптов на основе Java + самописные скрипты (XML, XSLT, JS и т.п.)
Соответствующее ПО для просмотра результатов Word, AdobeReader и т.п.
Блокнот, Paint (Gimp), Inkscape, Visio и т.п.

Из платных только Word и Visio под винду. Остальное бесплатно.

Изменено: ADVANCED - 25.04.2014 10:29:44

Leonid

Не определившийся

Сообщений: 2 Баллов: 1 Рейтинг: 6 Авторитет: 6 Регистрация: 24.04.2014

Мне нравится1

28.04.2014 12:46:12

ADVANCED, Спасибо за ответ!
Хотел уточнить:
- Много ли технических писателей в компании работает с этой технологией?
- Сколько времени ушло на внедрение (подбор/настройка ПО, настройка стилей\скриптов, обучение)?
- Используете ли Вы систему управления этим содержимым (CMS)?

Текрайтер из Питера

Студент

Сообщений: 69 Баллов: 55 Рейтинг: 8 Авторитет: 8 Регистрация: 20.02.2015

Мне нравится1

20.02.2015 22:13:32

Цитата

Leonid написал:
Здравствуйте, уважаемые специалисты по технической документации.

На форуме прочитал большое количество сообщений о технологиях XML (Docbook, DITA).

Могли бы Вы привести примеры использования технологий XML (Docbook, DITA) при разработке документации в Ваших компаниях:
- Какие типы документов выпускаете с помощью этих технологий?
- В каких форматах?
- Какие инструменты для этого используете?

Старый, конечно, пост, но я тоже отвечу за себя :)
1. Руководства администратора, пользователя, архитектура, спеки, relnotes, и т.п.
2. html, txt, pdf, epub
3. Стандарты: docbook-xml (DTD-based), docbook-xsl 1.78.1 (стандартный + свой customization layer)
Авторинг: XMLMind 3.5.2 (старый-старый, но бесплатный :)
Хранение: svn
Препроцесс: shell scripting
Визуализация (отдача): Apache Cocoon ( стандартые и кастомные генераторы/трансформеры/сериалайзеры).
Фактически: веб сайт с документацией (генерация on fly/on demand по нескольких срезам - аудитория/заказчик/ОС).

Изменено: Текрайтер из Питера - 20.02.2015 22:15:34

Читают тему