Dokumentationsverwaltung

369
Ondrej

Wir schreiben Dokumentation für einige unserer Softwareanwendungen. Diese Dokumentationsdokumente haben einige gemeinsame Inhaltsfragmente (z. B. Unternehmensprofil usw.).

Ich muss eine anständige Software finden, mit der wir die Formatierung dieses Dokuments konsistent verwalten können. Am besten wäre es möglich, einige globale Stilvorgaben zu bearbeiten, und jedes Mal, wenn ein Dokument veröffentlicht wird, sollte es den aktualisierten Stil wiedergeben.

Das Dokument besteht auch aus mehreren Fragmenten (den allgemeinen Teilen wie der Firmeneinführung und den produkt- oder dokumentenspezifischen Teilen). Es wäre sehr schön, wenn man die benötigten Fragmente auswählen und daraus Dokumente zusammenstellen könnte.

Hat jemand Erfahrung damit?

1
Word unterstützt die Verwendung von Vorlagen. Ramhound vor 10 Jahren 1
Das weiß ich natürlich ... aber ich suche etwas komplexeres. Word kann die Dokumentfragmente nicht zusammensetzen. Die Stiloptionen der Optionen haben Grenzen und das Problem, eine Aktualisierung des Stils in Bezug auf eine zentrale Stildefinition sicherzustellen. Ondrej vor 10 Jahren 0

2 Antworten auf die Frage

0
Adam

Sie können eine Vorlage zusammen mit den Dokumentstilen Automatisch aktualisieren verwenden, um die Formatierung des Stils aus der Vorlage zu synchronisieren.

Um wiederverwendbare Inhaltsfragmente zu definieren, verwenden Sie Autotext .

0
Guido Leenders

Ich habe besonders gute Erfahrungen mit Help & Manual eines österreichischen Unternehmens gemacht, siehe Firmenseite . Wir verwenden es seit 2004 und sind im Publishing flexibler als Word. Themen werden im XML-Format gespeichert und können durch Skripts generiert werden. Dateien können einfach mit CVS oder SVN versioniert werden.

Wir verwenden ein großes Projekt mit über 2000 Themen, um die einzelnen Produkthandbücher in einer Sprache zu erstellen. Einige der Produkte enthalten andere Produkte (z. B. wird unsere Projektmanagement-Lösung mit dem Abfrage-Editor geliefert, der auch als separates Produkt geliefert wird). Durch Build-Variablen steuern wir, was in einem bestimmten Produkthandbuch enthalten sein soll.

Aus der Hauptsprache leiten wir auch eine englische Version ab. Das Help & Manual-Projekt wird von OmegaT, einem computergestützten Übersetzungswerkzeug (Open Source), jedoch ähnlich wie Trados oder Memoq, verarbeitet. Vergleichen Sie die niederländische Version des Handbuchs (Basissprache) und die übersetzte Version

Alles kann durch Apache Ant-Builddateien ausgeführt werden.

Verwandte Probleme