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

349
Ondrej

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

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

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

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

1
Word поддерживает использование шаблонов. Ramhound 10 лет назад 1
Я знаю это, конечно ... но я ищу что-то более сложное. Word не может собрать фрагменты документа, его параметры стиля имеют ограничения, и его проблема заключается в обеспечении обновления стиля, связанного с некоторым центральным определением стиля. Ondrej 10 лет назад 0

2 ответа на вопрос

0
Adam

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

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

0
Guido Leenders

I have particularly good experiences with Help & Manual from some Austrian company, see company site. We've been using it since 2004 and it is more flexible in publishing than Word. Topics are stored in XML format and can be generated by scripts. Files can be easily versioned using CVS or SVN.

We use one big project with over 2000 topics to generate the individual product manuals in one language. Some of the products include other products (for instance our project management solution comes with the query editor, which also is shipped as a separate product). Through build variables we control what to include in a specific product manual.

From the main language we also derive an English version. The Help & Manual project is processed by OmegaT, a computer aided translation tool, open source, but similar to Trados or Memoq. Compare Dutch version of manual (base language) and translated version

Everything can be run through Apache Ant build files.

Похожие вопросы