Einsatz von XML
Übersicht
Anhand dieser Kriterien können Sie beurteilen, ob der Einsatz eines XML-Systems für Sie sinnvoll ist:
Wann lohnt sich der Einsatz von XML?
Die folgende Checkliste enthält 9 Kriterien, anhand derer der Sinn des Einsatzes eines XML-basierten Systems bewertet werden kann.
Wenn Sie bei unserer Checkliste nur zu einem oder zwei Kriterien voll JA sagen können, benötigen Sie wahrscheinlich kein XML-basiertes System. Finden Sie sich aber bei mehreren Kriterien wieder, steigt die Wahrscheinlichkeit, dass XML interessant für Sie sein könnte.
Umfang der Dokumentation
- Ist die Dokumentation sehr umfangreich und arbeiten daher mehrere Redakteure gleichzeitig an einem Dokumentationsprojekt?
- Werden die Dokumente gar an verschiedenen Unternehmensstandorten erstellt?
- Sollen die Dokumente trotzdem wie "aus einem Guss" wirken – also einer definierten Struktur entsprechen?
- Muss die vordefinierte Struktur sehr genau eingehalten werden? Benötigt dazu auch der Redakteur Unterstützung, der alleine an einer kompletten Dokumentation arbeitet?
Cross-Media-Publishing
- Sollen Handbücher, Online-Hilfen und Web-Dokumentation aus einer Quelle publiziert werden?
- Oder werden Handbücher in verschiedenen Layouts oder Papierformaten benötigt?
- Soll die Dokumentation in allen Medien oder in allen Formaten möglichst gleichzeitig fertig werden?
Übersetzungen
- Wird die Dokumentation in mehrere Sprachen übersetzt?
- Soll die Dokumentation in allen Sprachen möglichst gleichzeitig fertig werden?
Modularisierung und Mehrfachverwendung
- Können Teile der Dokumente (Module) in verschiedenen Publikationen (Handbücher, Online-Hilfen etc.) verwendet werden?
- Müssen Sie wissen, welche Module in welchen Publikationen verwendet werden?
Varianten
- Sind einzelne Publikationen Varianten von anderen, weil z. B. nur der Produktname anders ist?
- Oder werden für verschiedene Zielgruppen nur leicht unterschiedliche Publikationen erstellt?
Kundenspezifische Publikation
- Wird jede Dokumentation für jeden Kunden oder jeden Auftrag individuell erzeugt?
- Soll diese individuelle Dokumentation möglichst automatisiert zusammengestellt werden können?
- Sollen in eine Basisdokumentation kundenspezifische Informationen an bestimmten Stellen automatisch eingepflegt werden können?
Querverweise
- Müssen zwischen Modulen Querverweise gesetzt werden, die in möglicherweise auch in unterschiedlichen Publikationen verwendet werden?
- Ist es erforderlich, die Konsistenz und Aktualität dieser Querverweise zu kontrollieren?
Zeitnahe Publikation
- Ist es erforderlich, dass die Dokumentation gleichzeitig mit oder sogar vor dem Produkt fertig ist?
- Müssen trotzdem in letzter Minute noch Änderungen gemacht werden können, ohne die Auslieferung des Produktes zu verzögern?
Langlebigkeit und kontinuierliche Pflege
- Sind Sie als Produkthersteller verpflichtet, die Dokumentation über einen langen Zeitraum vorzuhalten?
- Müssen Sie die Dokumentation für ein ausgeliefertes Produkt entsprechend dem Stand der Technik oder nach durchgeführten Änderungen nachpflegen?
