DITA-XML für die Technische Dokumentation
DITA-XML: modular, automatisierbar und smart
Wir unterstützen Sie dabei, Technische Dokumentation mit DITA-XML so aufzubauen, dass Sie Inhalte an verschiedenen Stellen wiederverwenden und in unterschiedlichen Formaten publizieren können — mit oder ohne Redaktionssystem. DITA-XML ermöglicht topic-basiertes Schreiben und Single-Source-Publishing für smarte Technische Dokumentation.
Mit dem OASIS-Standard DITA-XML adressieren wir typische Anforderungen aus der Praxis: Sie erstellen Technische Dokumentation und möchten Inhalte für verschiedene Produktvarianten zentral pflegen und wiederverwenden. Die Dokumentation soll versioniert sein und von mehreren Autor:innen parallel gepflegt werden. Darüber hinaus möchten Sie die Inhalte in verschiedenen Formaten über unterschiedliche Kanäle ausspielen, z. B. auf einer Website, in einem Portal oder als Online-Hilfe.
Solche Herausforderungen mit herkömmlichen Dokumentformaten zu lösen, ist zeit- und kostenintensiv und kann zu Fehlern führen. Setzen Sie gemeinsam mit parson auf Technische Dokumentation mit DITA-XML. So arbeiten wir.
Ihre Ansprechpartner:innen
DITA-XML
Unsere Kundschaft
Wir finden Ihre individuelle DITA-Lösung. So arbeiten wir
- Dokumentation und Anforderungen analysieren. Gemeinsam mit Ihnen analysieren wir Ihre bestehende Technische Dokumentation sowie Ihre Anforderungen an Modularisierung und Wiederverwendung.
- DITA-XML einführen. Sie wollen Ihre DITA-XML-Authoring-Umgebung einrichten? Wir führen Sie durch den gesamten Prozess: Nach der Analyse Ihrer Anforderungen empfehlen wir die passenden Tools, entwickeln die passende Informationsarchitektur und richten die Autorenumgebung ein.
- DITA-basiertes Redaktionssystem (CCMS) einführen und einrichten. In größeren Dokumentationsprojekten wird DITA typischerweise in Verbindung mit einem Component Content Management System (CCMS) eingesetzt. In einem solchen System werden DITA-Topics, Metadaten und Varianten zentral verwaltet, wodurch Inhalte effizient wiederverwendet, versioniert und automatisiert publiziert werden können. Wir unterstützen Sie bei der Einführung Ihres DITA-basierten Redaktionssystems und begleiten Sie durch den gesamten Implementierungsprozess: von der Toolauswahl über die Entwicklung der Informationsarchitektur bis hin zur Konfiguration von Inhaltsstrukturen, Variantenmanagement und Metadaten – z.B. in Adobe AEM Guides, Empolis CLS, IXIASOFT oder Tridion Docs von RWS. Mehr über unsere Leistungen erfahren
- Plug-ins für DITA OT entwickeln. Wir entwickeln Plug-ins für das DITA Open Toolkit, um Publikationen in Ihrem Unternehmenslayout zu erzeugen: PDF, HTML, Webhilfe uvm.
DITA-XML-Daten veröffentlichen. Wir richten Publikations-Pipelines für verschiedene Ausgabekanäle ein, zum Beispiel für ein Content-Delivery-Portal oder einen Chatbot. Auf Wunsch unterstützen wir Sie bei der Implementierung des iiRDS-Standards.
- DITA-XML schulen. Wir bieten die E-Learning-Plattform "DITA lernen", auf der Sie kostenfrei DITA-XML lernen können. Oder wir schulen Ihr Redaktionsteam in DITA-XML und in Topic-basiertem Schreiben mit DITA-XML. Für Ihre Dokumentationstechniker:innen bieten wir Schulungen im DITA Open Toolkit. Schulungen bei parson
- Konzept für Modularisierung und Wiederverwendung erarbeiten. Wir erarbeiten ein individuell passendes Konzept zur Modularisierung und Wiederverwendung.
- In DITA-XML schreiben. Wir schreiben Ihre Dokumentation im DITA-XML-Standard.
Weitere Informationen rund um das Thema DITA-XML finden Sie in unseren FAQs.
FAQs – Häufig gestellte Fragen zu DITA-XML für die Technische Dokumentation
Was ist DITA-XML?
DITA steht für Darwin Information Typing Architecture. DITA ist ein XML-basiertes Format, mit dem strukturierte Inhalte unabhängig vom Autorensystem erstellt, organisiert und veröffentlicht werden können.
Da DITA ein offener, XML-basierter Standard ist, stehen eine Vielzahl von Werkzeugen zur Verfügung, um DITA-Dateien zu erstellen, zu bearbeiten, zu formatieren und zu verwalten. Abhängig von Ihren geschäftlichen Anforderungen können Sie ein Autorensystem wählen, das am besten zu Ihren Bedürfnissen passt.
Was ist das Besondere an DITA-XML?
- Topic-basierte Dokumentation und Single-Source Publishing. In DITA-XML organisieren Sie Ihre Technische Dokumentation in eigenständigen Topics. Diese Topics sind kurz genug, um ein einzelnes Thema zu beschreiben und lang genug, um alleinstehend sinnvoll zu sein. Topics sind die Bausteine, die Sie in einer DITA-Map organisieren und später in verschiedenen Formaten veröffentlichen. DITA-XML trennt die Inhalte vom Format. Ihre Technischen Redakteur:innen können sich ganz auf die Inhalte konzentrieren. Später können Sie die Inhalte automatisiert in mehreren Formaten veröffentlichen: HTML, Webhilfe, Print u.v.m.
- Wiederverwendung. Jeder Inhalt in DITA-XML existiert idealerweise nur einmal. So werden redundante Inhalte vermieden und damit das Duplizieren von Inhalten. Mit DITA-XML-pflegen Sie Informationen an einer zentralen Stelle und können sie an mehreren Stellen wiederverwenden.
- Smarte Dokumentation mit DITA-XML. DITA-Inhalte können mit Metadaten angereichert werden. Metadaten markieren verschiedene Dokumentationsvarianten, z.B. Inhalte für bestimmte Produktvarianten. Sie unterstützen aber auch die Suche und das Filtern von Inhalten in der Auslieferung, z.B. in einem Web-Portal. Als Grundlage für die Metadaten kann der Standard iiRDS verwendet werden. parson ist iiRDS-Experte. Mehr erfahren
Was ist Topic-orientiertes Schreiben?
Topic-orientiertes Schreiben ist eine Methode des strukturierten Schreibens, bei der Informationen als unabhängige und wiederverwendbare Einheiten erstellt werden – Topics. Ein Topic ist eine in sich abgeschlossene Informationseinheit und behandelt eine bestimmte Frage oder ein bestimmtes Problem.
Welche Topic-Typen gibt es in DITA-XML?
DITA-XML bietet verschiedene Topic-Typen für verschiedene Informationsbedürfnisse. Die folgenden Topic-Typen sind die bekanntesten:
- Task: Eine Aufgabenbeschreibung in Schritten mit einem Ergebnis.
- Concept: Ein Topic, in dem ein Sachverhalt oder Konzept erklärt wird.
- Reference: Informationen zum Nachschlagen von Fakten, z.B. technische Parameter.
- Troubleshooting: Informationen zur Fehlerbehebung.
Alle Topic-Typen können Sie miteinander verknüpfen. So bieten Sie den Nutzenden Ihrer Dokumentationen einen vollständigen Überblick über alle verfügbaren Informationen rund um ein Thema.
Ist DITA-XML ein Tool?
DITA-XML ist kein Tool. DITA-XML ist ein semantisches XML-Format, eine so genannte Dokumentendefinition. Es wird verwendet, um modulare Dokumentation zu erstellen und zu veröffentlichen – mit starkem Fokus auf Wiederverwendung und Variantenmanagement. DITA-XML ist ein Open-Source-Standard, der von mehreren Redaktionssystemen unterstützt wird, aber auch ohne Redaktionssystem genutzt werden kann. Mehr Informationen zu DITA-XML: Wikipedia und OASIS.
Brauche ich für DITA-XML ein Redaktionssystem?
Nicht unbedingt. Zum Erstellen der Inhalte können Sie einen XML-Editor verwenden, zum Beispiel Oxygen, und für das Veröffentlichen das DITA Open Toolkit (OT). Mehr Informationen zum DITA Open Toolkit
Es gibt verschiedene DITA-Autorensysteme auf dem Markt, die Sie zum Schreiben und Verwalten von DITA-Inhalten verwenden können. Das bekannteste System ist Oxygen XML Author, ein leistungsstarkes System mit benutzerfreundlicher Oberfläche, Validierung und Integration des DITA Open Toolkits. Oxygen-Produkt kaufen
Alternativ zu reinen XML-Editoren wie Oxygen können Sie auch ein Redaktionssystem (CCMS) verwenden, das DITA-XML als natives Dokumentformat verwendet. Beispiele hierfür sind IXIASOFT, RWS Tridion Docs, Heretto, Oxygen Content Fusion und XDocs.
Welche Ausgabeformate kann ich mit DITA-XML erstellen?
DITA-XML bietet eine Reihe von Ausgabeformaten: HTML, PDF, WebHelp oder mobile Apps. Ebenso können Sie mit DITA-XML Ausgabeformate wie ODT, Markdown und andere XML-basierte Formate erzeugen. Ausgabeformate werden in der Regel mit Skripten oder Werkzeugen erzeugt, wie das DITA Open Toolkit.
Was ist eine DITA-Map?
Mit einer DITA-Map organisieren Sie Ihre DITA-Topics in einer hierarchischen Struktur, ähnlich einem Dokument. Sie können eine DITA-Map für die Transformation der Inhalte in verschiedene Ausgabeformate verwenden.
Wie kann ich DITA-XML lernen?
Im Lernportal von parson lernen Sie DITA nach eigenem Tempo und kostenlos.
Gern bieten wir Ihnen auch eine individuelle Schulung, in der Sie die Grundlagen von DITA-XML kennenlernen. In unserer Schulung „Topic-basiertes Schreiben“ lernen Sie, wie Sie Topic-basierte Dokumentation erstellen, die auf Ihre Zielgruppen und Ihre Anwendungsumgebung zugeschnitten ist. Zu den Schulungen bei parson