White Paper. Nutzung der XML-Funktionen von Documentum zur Erstellung technischer Dokumentation

Transkript

1 White Paper Nutzung der XML-Funktionen von Documentum zur Erstellung technischer Dokumentation fme AG, Braunschweig Düsseldorf Frankfurt München Wolfsburg Alle Texte, Bilder und weitere hier veröffentlichte Informationen, mit Ausnahme der gekennzeichneten Artikel, unterliegen dem Copyright der fme AG. Eine Reproduktion oder Wiedergabe des Ganzen oder von Teilen ist ohne die schriftliche Genehmigung der fme AG ausgeschlossen. Wir achten alle eingetragenen Warenzeichen, deren Eigentümer wir nicht sind. Das Logo der fme ist Eigentum der fme AG und eingetragenes Warenzeichen. Alle Rechte vorbehalten.

2 Inhaltsverzeichnis 1 Neue Möglichkeiten durch XML Doppelte Arbeit doppelte Kosten Auswirkungen Vom Dokument zur Information Documentum und XML Arbeiten nach dem Bausteinkonzept Anbindung von XML-Editoren Style und Layout Übersetzungsmanagement Redaktionsprozess mit Documentum Dokumentieren mit Documentum & XML Glossar

3 Abbildungsverzeichnis Abbildung 1 - Bausteinkonzept... 7 Abbildung 2 - Epic Editor mit Documentum Integration... 8 Abbildung 3 - Generierprozess... 9 Abbildung 4 - Redaktionsprozess mit Documentum

4 Inhalte einmal erfassen und in verschiedene Medien publizieren, automatische Verlinkung, Wiederverwendung von Grafiken und Textbausteinen, Übersetzungsmanagement moderne Dokumentenmanagement-Systeme bieten vielfältige Möglichkeiten, den technischen Redaktionsprozess zu unterstützen und so schneller und kostengünstiger zu einer qualitativ hochwertigen Dokumentation zu gelangen. Hierzu kommen XML-Features zum Einsatz, die in Kombination mit klassischen Dokumentenmanagement-Funktionen, beispielsweise Rechtekonzept, Versionierung, und Workflow, einen großen und sehr hilfreichen Leistungsumfang bieten können. 1 Neue Möglichkeiten durch XML Mit XML hat sich heute ein Standard etabliert, der den nahezu grenzenlosen Austausch von Information zwischen Systemen und die Umwandlung in fast jedes beliebige Format ermöglicht. Ein System, welches in der Lage ist, mit XML umzugehen und dessen herausragende Eigenschaften zu nutzen, bietet entscheidende Vorteile bei der Erstellung von technischer Dokumentation: Automatisierung von Prozessen, Wiederverwendung von Bausteinen, effiziente Zusammenarbeit mit Partnern und automatisches Publizieren in vielfältige Formate bzw. Medien. Durch den Einsatz von XML kann ein Redaktionssystem gleichzeitig als Content-, oder auch Informations-Management-System fungieren. Dieses bildet das Schlüsselelement zur Informationserstellung, -findung und -wiederverwendung im gesamten Unternehmen und macht so Wissen erst richtig wertvoll und nutzbar. Dieses White Paper beschreibt den Funktionsumfang, den Dokumentenmanagement- Systeme speziell im Zusammenhang mit technischer Dokumentation bieten können. Es werden insbesondere die Funktionalitäten betrachtet, die das Arbeiten mit XML-Content vereinfachen und ein Unternehmen dabei unterstützen, die umfangreichen Möglichkeiten von XML auszuschöpfen, um entscheidende Wettbewerbsvorteile zu erzielen. 2 Doppelte Arbeit doppelte Kosten Der Erstellungsprozess für Technische Dokumentationen wie zum Beispiel Handbücher, Betriebsanleitungen, Fachkonzepte oder Lastenhefte besteht bisher überwiegend aus aufwendigen, manuellen Redaktionsprozessen, oft unter Einsatz von Office Systemen. Dabei müssen die Autoren ein Dokument nicht nur verfassen, sondern auch gleichzeitig formatieren. Die Integration von CAD-Zeichnungen, die Zusammenarbeit mit anderen 4

5 Autoren und das Einbringen von Änderungen sind oft komplex, zeitaufwendig und somit auch fehleranfällig. Im Ergebnis sind die im Dokument enthaltenen Informationen nicht wiederverwendbar, sondern in ihm gefangen. Damit solche Informationen über verschiedene Kanäle bereitgestellt werden können, müssen sie aufwendig in neuen Formaten erstellt werden. Nicht selten müssen hiermit externe Agenturen beauftragt werden. Hinzu kommen hohe Aufwände für die Übersetzung der Dokumente, die oftmals sogar eine erneute Anpassung des Layouts und somit weitere Kosten bedingt. 3 Auswirkungen 4 Vom Dokument zur Information Die Lösung dieser Probleme bietet der Einsatz des XML-Standards. XML ist ein sehr einfaches und flexibles Datenhaltungsformat, das mittlerweile als Standard für Informationsbereitstellung in allen Unternehmensapplikationen gilt. Ein Grundprinzip ist die strenge Trennung von Inhalt und Layout. Dieses Konzept ermöglicht es, denselben Inhalt mit unterschiedlichen Layout- und Formatinformationen zu kom- 5

6 binieren und so über verschiedene Kanäle zu publizieren. So kann ein Produktkatalog ohne manuelle Anpassungen z. B. als Druckausgabe, auf CD-Rom und im Internet publiziert werden. In XML-basierenden Systemen können sich die Autoren vollständig auf die Erstellung des Inhalts konzentrieren, während das Layout an zentraler Stelle gepflegt wird. Ein weiteres Grundprinzip ist die Betrachtung eines Dokuments als Zusammenstellung von Informationsbausteinen. Aus diesem Zusammenhang stammt auch der Begriff des strukturierten Dokuments. Dabei können Inhalte nach dem Bausteinprinzip zu einem Dokument zusammengestellt werden. So können AGBs, Warnhinweise oder Adressen als zentrale Bausteine gehalten werden. Die Adresse muss nur an einer zentralen Stelle gepflegt werden und wird in den Dokumenten automatisch aktuell gehalten. Sogar die automatische Dokumentzusammenstellung anhand von Stücklisten ist möglich. Nach dem gleichen Prinzip wie auch Bausteine aus anderen Systemen bereitgestellt werden können, beispielsweise Preise aus dem ERP System, kann auch eine XML- Dokumentation Informationen für weitere Systeme liefern z.b. die neuesten technischen Daten für Vertrieb und Marketing. 5 Documentum und XML Eines der etablierten Dokumentenmanagement-Systeme, Documentum, kommt von dem amerikanischen Anbieter EMC. Viele Firmen nutzen bislang primär die Dokumentenmanagement-Funktionen von Documentum. Dabei bringt Documentum durch seine Architektur von Haus aus alle Funktionalitäten mit, die auch das Arbeiten mit XML durchgängig ermöglichen. Es stehen die bei allen Contenttypen gebräuchlichen Funktionen wie Volltextsuche, Zugriffskontrolle, Versionskontrolle, Workflow und Lebenszyklusverwaltung uneingeschränkt zur Verfügung. Hinzu kommen XML-spezifische Funktionen wie: Automatische Zerlegung in Bausteine (Chunking) Content-Aufbereitung für externe Applikationen Publizieren in unterschiedliche Formate (XSL-Transformationen) Syntax-Prüfung (XML-Validierung) Link-Management Wiederverwendung von Bausteinen Mächtige Suchfunktionen über Inhalt und Metadaten Alle Funktionen können über den Documentum Application Builder komfortabel und ohne den Einsatz von Zusatzmodulen konfiguriert werden. 6

7 6 Arbeiten nach dem Bausteinkonzept Um die Vorteile der Wiederverwendung ideal nutzen zu können, wird die Dokumentation in Bausteine zerlegt. Alle Bausteine, die regelmäßig verwendet werden, werden in einem zentralen Baustein-Repository abgelegt. Bausteine können so genannte XML-Chunks darstellen, die z. B. einen Textabschnitt, einen Warnhinweis oder ein ganzes Kapitel repräsentieren. Sie können aber auch normale Objekte sein, wie beispielsweise Grafiken. Mit Hilfe der Documentum-Ablagen und -Ordner kann das Repository benutzerspezifisch organisiert werden. Abbildung 1 zeigt, wie das Handbuch eines Krans unter Verwendung von Bausteinen und modelspezifischen Textabschnitten zusammenstellt wird. Auf diese Weise ergeben sich virtuelle Dokumente in Documentum, welche aus einem ganzen Baum an Komponenten bestehen. Jeder dieser Chunks besitzt in Documentum ebenfalls Objekteigenschaften wie die Versionierung, eigene Zugriffsrechte und Metadaten. So ist jederzeit nachvollziehbar, welcher Baustein wo verwendet wurde, auf welche Dokumente sich Änderungen auswirken und wer der verantwortliche Autor für einen bestimmten Abschnitt ist. Kran (Modell 4711) Kran (Modell 4711 Variante A) Zentrales Baustein- Repository Fahrersitz (Modell X) Adresse (Vertrieb DE) Fahrersitz Handbuch Beschreibung (Hebevorrichtung) Beschreibung (Fahrwerk) Fahrersitz Handbuch Beschreibung (Hebevorrichtung) Beschreibung (Fahrwerk A) ( ) ( ) Adresse (Vertrieb DE) Adresse (Vertrieb DE) Abbildung 1 - Bausteinkonzept Die Zusammenstellung von Bausteinen zu einem Handbuch kann manuell durch den technischen Redakteur oder elektronisch erfolgen. Durch dieses Prinzip kann anhand einer Maschinenkonfiguration oder mit Informationen aus dem Warenwirtschaftssystem bereits ein großer Teil der Dokumentation automatisch zusammengestellt und so der Redaktionsprozess beschleunigt werden. 7

8 7 Anbindung von XML-Editoren Um effektiv im gesamten Unternehmen eingesetzt werden zu können, muss ein Content- Management-System das einfache, komfortable Erstellen von XML-Content ermöglichen. Abbildung 2 - Epic Editor mit Documentum Integration Dies unterstützt Documentum durch die Anbindung von XML-Editoren. Die auf dem Markt am weitesten verbreiteten Editoren Epic Editor und XMetaL verfügen über eine integrierte Documentum-Schnittstelle, durch die der direkte Zugriff auf Bausteine in Documentum möglich ist. Auch das Ein- und Auschecken sowie die Suche nach wiederverwendbaren Komponenten kann direkt über das Menü des Editors ausgeführt werden. Die Editoren sind so konzipiert, dass auch Redakteure ohne detaillierte XML-Kenntnisse problemlos mit ihnen arbeiten können. Auch auf die aus der Office-Welt bekannten komforterhöhenden Funktionen wie Rechtschreibkontrolle, Änderungsverfolgung und Makros muss nicht verzichtet werden. 8 Style und Layout Ebenfalls als Objekte an zentraler Stelle in Documentum gespeichert und verwaltet werden die Layoutanweisungen in Form von Stylesheets und XSL-Anweisungen. Sie enthalten die Informationen für die Überführung von XML-Content in andere Formate. Unter Verwendung dieser Anweisungen werden z. B. die Inhalte aus dem XML-Handbuch in Abbildung 1 mit einem Layout versehen und in das gewünschte Format überführt. Dasselbe XML-Handbuch bildet kombiniert mit jeweils unterschiedlichen Styleanweisungen die Grundlage für die Publikation als Druckausgabe auf CD Rom oder auf portablen Geräten. 8

9 Abbildung 3 - Generierprozess Der große Vorteil dieser Vorgehensweise: Eine Änderung im Layout, z. B. des Corporate Designs, hat keine Auswirkungen mehr auf das eigentliche Handbuch. Lediglich die Style- Information muss aktualisiert werden. In Documentum wird das Ergebnis einer Transformation als Rendition abgelegt und kann somit jederzeit abgerufen werden. Transformationen können vom Benutzer manuell oder automatisiert durch Workflows, Lifecycles oder bestimmte Ereignisse gestartet werden. 9 Übersetzungsmanagement Schon die konsequente Nutzung des Bausteinkonzepts ermöglicht Einsparungen bei der Übersetzung, denn ein bereits übersetzter Baustein muss nicht noch einmal übersetzt werden, egal an wie vielen Stellen er verwendet wird. Zusätzlich lassen sich Einsparungen durch das vom Documentum Content Server bereitgestellte Multilingual Rendition Management erzielen. Diese Funktion verwaltet XML-Komponenten mit demselben logischen Inhalt in unterschiedlichen Sprachen. Dabei können die Übersetzungen als einzelne Objekte oder als multilinguale Renditions organisiert werden. Documentum unterstützt auch das Definieren von Prozessregeln, z.b. die Benachrichtigung des Übersetzungsbüros, wenn Bausteine in der Originalsprache verändert wurden. 9

10 10 Redaktionsprozess mit Documentum Abbildung 4 - Redaktionsprozess mit Documentum Content-Erfassung XML-Bausteine, Zeichnungen, Multimediadateien werden von den Autoren erstellt. Weitere Elemente wie z.b. CAD-Zeichnungen können aus externen Systemen übernommen werden. Content-Verwaltung Content in Documentum erfährt zahlreiche Features zur effizienten Verwaltung und verteilten Bearbeitung. Rechtekonzept, Lifecycle und Metadaten werden gleichermaßen auf Dokumente wie auch auf XML-Bausteine angewendet. Mehrsprachige Ausgaben werden mit Unterstützung des Übersetzungsmanagements erstellt. Die einzelnen Elemente werden zu einem virtuellen Dokument zusammengestellt. 10

11 Content-Publikation Durch XSL-Transformationen können nahezu beliebige Ausgabeformate erzeugt werden. Ziele könnten zum Beispiel Printmedien, Portale oder Webpräsenzen sein. XML-Content-Archivierung Wie auch jeder andere Content muss XML-Content über seinem Veröffentlichungszeitraum hinaus verwaltet werden. Werden Inhalte aktualisiert oder der Veröffentlichungszeitraum überschritten, so wird der alte Content archiviert. Das Archivieren erfolgt dabei automatisch nach definierbaren Richtlinien. Mit der Snapshot- Funktion in Documentum können Ausgabestände als Editions eingefroren werden. 11 Dokumentieren mit Documentum & XML Nicht nur für Großunternehmen bietet eine XML-basierte Dokumentation ein Potential zur Leistungssteigerung. Alle Unternehmen, die technische Dokumentation in mehreren Sprachen, Layoutvarianten und für zunehmend differenzierte Zielgruppen erstellen müssen, können durch den Einsatz von Content-Management-Systemen den Redaktionsprozess kostengünstiger und effizienter gestalten. Gleichzeitig werden höchste Qualitätsstandards erreicht. Die einzigartige Kombination von XML-Content-Management und ECM macht dabei Documentum zu einem der mächtigsten Systeme für die Erstellung XML-basierter Dokumentation. Alle von anderen Dokumenttypen bekannten Funktionen sind gleichermaßen auch für XML-Bausteine und Layoutanweisungen verfügbar. XML-Inhalte lassen sich problemlos mit Grafiken, CAD-Zeichnungen oder Multimediaobjekten kombinieren. Die Integration von XML-Editoren unterstützt die Autoren beim komfortablen Erstellen des XML- Contents. Durch Standard-Schnittstellen zu vielen weiteren Systemen wie z. B. SAP ermöglicht Documentum eine durchgängige Informationsverteilung im gesamten Unternehmen und eine ganzheitliche Umsetzung des Single-Source-Prinzips. Documentum hat sich gerade bei der Verwaltung von großen Datenmengen und beim standortübergreifenden Arbeiten vielfach bewährt. EMC Documentum engagiert sich darüber hinaus bei der Weiterentwicklung von XML-Themen, unter anderem als Mitglied von OASIS, UDDI.org und W3C sowie als Gründungsmitglied von XML.org. Damit wird die Bedeutung des XML-Standards durch den Hersteller anerkannt und aktiv gefördert, was auch die künftige Unterstützung erwarten lässt. Insbesondere solche Unternehmen, die bereits Documentum einsetzen, können so mit geringem Aufwand eine stabile Grundlage für die Erstellung ihrer technischen Dokumentation schaffen, die aktuellen und auch künftigen Standards entspricht. 11

12 12 Glossar chunking Compliance Content DTD Rendition Repository Schema Tansformation Virtuelles Dokument well formed XML-Chunks XML-Validierung XSL-Stylesheet XSLT (deutsch: aufbrechen) Aufspaltung eines XML-Dokuments in Bausteine Bezeichnet in der betriebswirtschaftlichen Fachsprache die Einhaltung von Gesetzen und Richtlinien, aber auch freiwilligen Kodices in Unternehmen. Die Sicherstellung von Compliance in Unternehmen kann durch organisatorische Maßnahmen gestützt werden. (deutsch: Inhalt) Als Content wird der unformatierte Teil eines Dokuments bezeichnet; Inhalt ohne Layoutanweisungen (Document Type Definition) Die DTD beschreibt den Aufbau einer XML-Datei, dazu gehören Regeln für die Verwendung von Tags und Attributen. (deutsch: Darbietung, Umsetzung) Abbildung eines Documentum- Objekts in unterschiedlichen Varianten, z.b. verschiedene Dateiformate oder Sprachen (deutsch: Ablage, Depot) Zentraler Speicherort Eine Alternative zur DTD mit Möglichkeiten, die über die Funktionalitäten einer DTD hinausgehen Der Vorgang XML-Content in eine andere Form zu überführen. Dabei kann das Zielformat entweder eine andere XML-Form (zum Datenaustausch mit anderen Systemen) oder ein anderes Datenformat wie PDF, HTML oder MS Word sein. Dokument, das aus einer Zusammenstellung vieler anderer Elemente, den so genannten Bausteinen, besteht (deutsch: wohlgeformt ) Eine XML-Datei wird als well formed bezeichnet, wenn sie zwar den formellen Anforderungen an eine XML-Datei entspricht, aber nicht gegen eine DTD oder ein Schema validiert wurde. XML-Bausteine Überprüfung, ob eine XML-Datei den Regeln, die in der DTD oder im Schema definiert wurden, entspricht (Extensible Stylesheet Language Stylesheet) Ein XSL-Stylesheet enthält Layoutinformationen für XML-Dokumente (Extensible Stylesheet Language Transformation) Programmiersprache zur Überführung von XML in andere Datenformate 12