Управление документацией

Question

Мы пишем документацию для нескольких наших программных приложений. Эти документы документации имеют общие фрагменты контента (например, корпоративный профиль и т.д.).

Мне нужно найти достойное программное обеспечение, которое позволило бы нам последовательно управлять форматированием этих документов. Было бы лучше, если бы можно было изменить некоторые глобальные настройки стиля, а затем каждый раз, когда документ публикуется, он должен отражать обновленный стиль.

Кроме того, документ состоит из нескольких фрагментов (общие части, такие как введение компании и части, касающиеся продукта или документа). Было бы очень хорошо, если бы можно было выбрать нужные фрагменты и собрать из них документы.

У кого-нибудь есть опыт с этим?

Answer 1

Вы можете использовать шаблон вместе с Автоматически обновлять стили документа для синхронизации форматирования стиля из шаблона.

Чтобы определить повторно используемые фрагменты контента, изучите использование автотекста.

Answer 2

У меня особенно хороший опыт работы с Help & Manual какой-то австрийской компании, см. Сайт компании. Мы используем его с 2004 года, и он более гибок в публикации, чем Word. Темы хранятся в формате XML и могут быть созданы сценариями. Файлы могут быть легко версии с использованием CVS или SVN.

Мы используем один большой проект с более чем 2000 тем для создания отдельных руководств по продукту на одном языке. Некоторые из продуктов включают другие продукты (например, наше решение для управления проектами поставляется с редактором запросов, который также поставляется как отдельный продукт). Через переменные сборки мы контролируем, что включать в конкретное руководство по продукту.

Из основного языка мы также получаем английскую версию. Проект Help & Manual обрабатывается OmegaT, средством автоматизированного перевода, с открытым исходным кодом, но похожим на Trados или Memoq. Сравните голландскую версию руководства (базовый язык) и переведенную версию

Все можно запустить через файлы сборки Apache Ant.