Sollten Sie glauben, dass das wirklich ganz einfach geht, dann hören Sie besser auf zu lesen. Sie würden sich nur ärgern.
Sollten Sie aber daran interessiert sein, wie man statt dessen clever dokumentiert, dann sind Sie hier schon besser aufgehoben.
Warum haftet dem Dokumentieren, und hier speziell der
Dokumentation für den Anwender, so oft der Makel an, sie sei mühselig und nervtötend? Kaum jemand reißt sich um die Aufgabe,es sei denn technische Redakteure.
Eine Erklärung ist, dass die Erstellung dieser Art von Dokumentation in Projekten sehr oft unter enormem Zeitdruck am Ende eines Projekts durchgeführt wird. Im schlimmsten Fall werden Personen beauftragt, die kein Talent zum Schreiben und Dokumentieren nie
gelernt haben. Von einer Organisationsstruktur, die den
Dokumentationsprozess trägt, ganz zu schweigen. Dokumentation als notwendiges Übel.
Gleichzeitig sollen und müssen unterschiedliche Arten von
Dokumentationen wie Benutzerhandbücher, Hilfesysteme und
Trainingsunterlagen in hoher Qualität und kurzer Zeit für
unterschiedliche Zielgruppen verfasst werden. Wird hier - wie so oft - nicht sorgfältig geplant und Dokumentieren als wichtige Aufgabe im Projekt angesehen, ist Chaos und Mehrarbeit vorprogrammiert. Wer möchte da schon gerne beteiligt sein?
Betrachtet man die so unterschiedlichen Publikationsformen wie Benutzerhandbücher, Hilfesysteme und Trainingsunterlagen, so haben diese etwas gemeinsam: sie befassen sich inhaltlich mit den selben Themen, wenn auch aus unterschiedlichen Blickwinkeln, z.B. mit der Bedienung einer bestimmten Funktion einer Software oder eines Geräts.
Eine weitere Gemeinsamkeit ist, dass die Art Dokumentation, von der hier die Rede ist, Informationen an Anwender vermitteln soll.
Diese Gemeinsamkeiten kann man sich zu Nutze machen, indem
man die Information so in Module aufteilt, dass diese für jede Dokumentationsart zu verwenden sind. Information wird mehrfach verwendet, aber nur einmal gepflegt.
So reizvoll dieses Potential ist, so erschließt es sich nicht von alleine. Zunächst einmal muss die Information auf ihre Eignung hin untersucht werden, ob sie sich zur Modularisierung und Wiederverwendung eignet. Es gibt hier eine Reihe von Methoden, die diesen Prozess unterstützen. Die Methoden Information- oder Mindmapping unterstützen auf dem Weg, Information modular zu strukturieren.
Eine weitere zwingende Voraussetzung für qualitativ hochwertige und wiederverwendbare Module ist ein Redaktionsleitfaden, der die inhaltliche und sprachliche Gestaltung detailliert regelt. Die Erstellung derartiger Leitfäden ist eine Sache für Spezialisten, und es empfiehlt sich hier bei Bedarf Rat einzuholen.
Leider ist eine Strukturierungsmethode oder die Existenz eines Redaktionsleitfaden alleine noch keine Gewähr dafür, dass die dort getroffenen Festlegungen auch von allen Beteiligten gelebt werden. Daher ist eine Organisationsstruktur erforderlich, mit der die erforderliche Qualitätssicherung durchgeführt werden kann.
Ist die Information nun in Module gegliedert, ist für eine durchgängige Formulierung gesorgt und eine Dokumentationsprozess festgelegt, steht noch die Frage im Raum, mit welchen Tools dokumentiert werden soll. Mehrfachverwendung von modularisierter Information
legt einen automatisierten Informationsprozess auf der Basis von Modulstücklisten nahe. Die unterschiedlichen Publikationsformen erfordern beim Verfassen der Information ein Vorgehen, das sich ausschließlich am Inhalt und nicht am Layout orientiert. Zieht man
diese Umstände in Betracht so bietet sich XML als
Dokumentationsformat an. Vor der Auswahl eines XML-Systems
sollten Informationsstruktur, erforderliche Zielmedien, Sprachen und Dokumentationsprozesse festliegen. Ein weiteres wesentliches Kriterium ist die Fähigkeit Dokumente zu archivieren. All diese Themenstellungen adressiert das Content Management- und Redaktionssystem X-DOCU.
Mit X-Docu wird der gesamte Redaktionsprozess ‒ von der
Erstellung der Inhalte durch die Autoren bis hin zur Produktion und Veröffentlichung in den unterschiedlichsten Medien ‒ in einem System gesteuert. Das X-Docu System sichert durch die Verwendung zukunftssicherer Technologien die Integrationin bestehende firmeneigene Netzwerke.
Wesentliches Merkmal von X-Docu ist die gleichzeitige Erstellung von unterschiedlichen Medien im Single-Source-Prinzip aus XMLDateien.
Die Inhalte Ihrer Dokumentationsprojekte lassen sich im
Baukastenprinzip frei kombinieren.
Dreh- und Angelpunkt von X-Docu ist die konsequente Verwendung von XML als Standard und medien- und plattformunabhängiges Format. Alle Informationen werden als XML-Dateien erfasst und abgelegt. Mit XML wird sichergestellt, dass Inhalte unabhängig von der gewünschten Ausgabe erstellt und zu einem späteren Zeitpunkt in jedem möglichen Medium publiziert werden können. Das Layout des jeweiligen Mediums ist an zentraler Stelle festgelegt und sorgt für ein einheitliches Erscheinungsbild.
Das X-Docu Redaktionssystem besteht aus den
Systemkomponenten X-Docu Authoring System zur Erstellung,
Bearbeitung und Verwaltung von Inhalten für XML-basierte
Dokumentationen, dem X-Docu Content Management System zur
Versionierung aller Daten auf einem zentralen Archivserver, dem XDocuProduction System zur Produktion von Web Based Trainings, Printmedien und SCORM-Inhalten. Auf Autorensystem, Produktionssystem und Archivserver greifen sowohl Editoren als auch Administratoren per Internet / Intranet mittels http(s)-Protokoll
zu. Dies garantiert größtmögliche Vereinfachung in der technischen Administration. Die Integration neuer Benutzer ist einfach, da die Autorensoftware als Webapplikation ausgeführt ist. Weltweites Deployment und die Zusammenarbeit mit externen Partnern wird so optimalunterstützt. Alle Administrationsoberflächen (X-Docu
Production System und X-Docu WBT) werden über Browser bedient.
Das gesamte X-Docu System basiert auf der J2EE (Java EnterpriseEdition). J2EE ist eine plattformunabhängige Spezifikation, um Softwarebestandteile unterschiedlicher Hersteller miteinander operabel zu machen. J2EE als konsequent genutzter Standard garantiert Systemoffenheit, Konformität, Modularität und erheblichen Investitionsschutz. X-Docu kann somit in fast jedes firmeneigene Netzwerk integriert werden. Kundenanpassungen sind jederzeit flexibel realisierbar.
Alle Inhalte werden mit X-Docu als unabhängige Einheiten in Form von XML-Modulen verfasst. Diese werden an einer Stelle sinnvoll strukturiert abgespeichert, um sie zentral zur freien Kombination, mehrfachen Verwendbarkeit und weiteren Verarbeitung bereitzustellen. Aus diesem Pool einzelner Module können individuelle Projekte zusammengestellt und produziert werden. Auf diese Weise können Benutzerdokumentationen, Handbücher oder spezielle Dokumentationen bereitgestellt werden. Die Medienunabhängigkeit von XML erlaubt die Erstellung von PDF, RTF,DocBook, Webapplikationen, SCORM-kompatiblen Modulen oder JavaHelp. Neuestes Feature ist die Interaktion mit WIKIs zur Sicherung des Unternehmens-Know How. Modulare Struktur, Redaktionsrichtlinien, Organisationsstrukturen, neue Dokumentationsprozesse und XML mit den erforderlichen Tools, all dies sind Dinge, die in den bereits vorhandenen Dokumentationsprozess eventuell neu eingeführt werden müssen.
Lohnt sich dieser Aufwand überhaupt?
Die Antwort auf diese Frage lässt sich aus wirtschaftlicher Sicht leicht beantworten, wenn man die Größen Gesamtumfang der Information, Grad der Wiederverwendung, Anzahl der Sprachen, Überarbeitungszyklen und erforderliche Publikationsmedien kennt. Mit diesen Größen lässt sich berechnen, welcher wirtschaftliche Nutzen den oben genannten Aufwänden gegenübersteht. Wichtig ist hierbei, dass der Nutzen nicht alleine bei der erstmaligen Erstellung entsteht, sondern vor allem bei der Überarbeitung der Information.
Als Faustregel gilt: je umfangreicher die Dokumentation und je höherder Grad der Wiederverwendung, desto höher der wirtschaftliche Nutzen.
Beispielrechnungen können zeigen, dass bereits mit der
Ersterstellung der Unterlagen die Investitionskosten mindestens amortisiert, wenn nicht sogar deutlich überkompensiert werden. Diese positive Bilanz setzt sich dann mit jedem Update der Dokumentation fort. Einsparungen um die 100% sind an der Tagesordnung.
Daneben stehen übersichtliche, gut strukturierte Informationen und sprachliche Durchgängigkeit sowie ein geordneter Dokumentationsprozess als Plus auf der qualitativen Seite.
Stehen Sie also vor der Frage, ob Sie Ihren Dokumentationsprozess in der beschriebenen Form gestalten wollen, kommen Sie zunächst um eine Analyse Ihrer Informationen nicht herum. Diese Analyse hilft
Ihnen in jedem Fall, einen geeigneten Dokumentationsprozess zu finden und ist wirklich kein Hexenwerk. Der potentielle wirtschaftliche
Nutzen einer modularisierten Informationsstruktur ist die Mühe allemal wert.
Sollten Sie aber daran interessiert sein, wie man statt dessen clever dokumentiert, dann sind Sie hier schon besser aufgehoben.
Warum haftet dem Dokumentieren, und hier speziell der
Dokumentation für den Anwender, so oft der Makel an, sie sei mühselig und nervtötend? Kaum jemand reißt sich um die Aufgabe,es sei denn technische Redakteure.
Eine Erklärung ist, dass die Erstellung dieser Art von Dokumentation in Projekten sehr oft unter enormem Zeitdruck am Ende eines Projekts durchgeführt wird. Im schlimmsten Fall werden Personen beauftragt, die kein Talent zum Schreiben und Dokumentieren nie
gelernt haben. Von einer Organisationsstruktur, die den
Dokumentationsprozess trägt, ganz zu schweigen. Dokumentation als notwendiges Übel.
Gleichzeitig sollen und müssen unterschiedliche Arten von
Dokumentationen wie Benutzerhandbücher, Hilfesysteme und
Trainingsunterlagen in hoher Qualität und kurzer Zeit für
unterschiedliche Zielgruppen verfasst werden. Wird hier - wie so oft - nicht sorgfältig geplant und Dokumentieren als wichtige Aufgabe im Projekt angesehen, ist Chaos und Mehrarbeit vorprogrammiert. Wer möchte da schon gerne beteiligt sein?
Betrachtet man die so unterschiedlichen Publikationsformen wie Benutzerhandbücher, Hilfesysteme und Trainingsunterlagen, so haben diese etwas gemeinsam: sie befassen sich inhaltlich mit den selben Themen, wenn auch aus unterschiedlichen Blickwinkeln, z.B. mit der Bedienung einer bestimmten Funktion einer Software oder eines Geräts.
Eine weitere Gemeinsamkeit ist, dass die Art Dokumentation, von der hier die Rede ist, Informationen an Anwender vermitteln soll.
Diese Gemeinsamkeiten kann man sich zu Nutze machen, indem
man die Information so in Module aufteilt, dass diese für jede Dokumentationsart zu verwenden sind. Information wird mehrfach verwendet, aber nur einmal gepflegt.
So reizvoll dieses Potential ist, so erschließt es sich nicht von alleine. Zunächst einmal muss die Information auf ihre Eignung hin untersucht werden, ob sie sich zur Modularisierung und Wiederverwendung eignet. Es gibt hier eine Reihe von Methoden, die diesen Prozess unterstützen. Die Methoden Information- oder Mindmapping unterstützen auf dem Weg, Information modular zu strukturieren.
Eine weitere zwingende Voraussetzung für qualitativ hochwertige und wiederverwendbare Module ist ein Redaktionsleitfaden, der die inhaltliche und sprachliche Gestaltung detailliert regelt. Die Erstellung derartiger Leitfäden ist eine Sache für Spezialisten, und es empfiehlt sich hier bei Bedarf Rat einzuholen.
Leider ist eine Strukturierungsmethode oder die Existenz eines Redaktionsleitfaden alleine noch keine Gewähr dafür, dass die dort getroffenen Festlegungen auch von allen Beteiligten gelebt werden. Daher ist eine Organisationsstruktur erforderlich, mit der die erforderliche Qualitätssicherung durchgeführt werden kann.
Ist die Information nun in Module gegliedert, ist für eine durchgängige Formulierung gesorgt und eine Dokumentationsprozess festgelegt, steht noch die Frage im Raum, mit welchen Tools dokumentiert werden soll. Mehrfachverwendung von modularisierter Information
legt einen automatisierten Informationsprozess auf der Basis von Modulstücklisten nahe. Die unterschiedlichen Publikationsformen erfordern beim Verfassen der Information ein Vorgehen, das sich ausschließlich am Inhalt und nicht am Layout orientiert. Zieht man
diese Umstände in Betracht so bietet sich XML als
Dokumentationsformat an. Vor der Auswahl eines XML-Systems
sollten Informationsstruktur, erforderliche Zielmedien, Sprachen und Dokumentationsprozesse festliegen. Ein weiteres wesentliches Kriterium ist die Fähigkeit Dokumente zu archivieren. All diese Themenstellungen adressiert das Content Management- und Redaktionssystem X-DOCU.
Mit X-Docu wird der gesamte Redaktionsprozess ‒ von der
Erstellung der Inhalte durch die Autoren bis hin zur Produktion und Veröffentlichung in den unterschiedlichsten Medien ‒ in einem System gesteuert. Das X-Docu System sichert durch die Verwendung zukunftssicherer Technologien die Integrationin bestehende firmeneigene Netzwerke.
Wesentliches Merkmal von X-Docu ist die gleichzeitige Erstellung von unterschiedlichen Medien im Single-Source-Prinzip aus XMLDateien.
Die Inhalte Ihrer Dokumentationsprojekte lassen sich im
Baukastenprinzip frei kombinieren.
Dreh- und Angelpunkt von X-Docu ist die konsequente Verwendung von XML als Standard und medien- und plattformunabhängiges Format. Alle Informationen werden als XML-Dateien erfasst und abgelegt. Mit XML wird sichergestellt, dass Inhalte unabhängig von der gewünschten Ausgabe erstellt und zu einem späteren Zeitpunkt in jedem möglichen Medium publiziert werden können. Das Layout des jeweiligen Mediums ist an zentraler Stelle festgelegt und sorgt für ein einheitliches Erscheinungsbild.
Das X-Docu Redaktionssystem besteht aus den
Systemkomponenten X-Docu Authoring System zur Erstellung,
Bearbeitung und Verwaltung von Inhalten für XML-basierte
Dokumentationen, dem X-Docu Content Management System zur
Versionierung aller Daten auf einem zentralen Archivserver, dem XDocuProduction System zur Produktion von Web Based Trainings, Printmedien und SCORM-Inhalten. Auf Autorensystem, Produktionssystem und Archivserver greifen sowohl Editoren als auch Administratoren per Internet / Intranet mittels http(s)-Protokoll
zu. Dies garantiert größtmögliche Vereinfachung in der technischen Administration. Die Integration neuer Benutzer ist einfach, da die Autorensoftware als Webapplikation ausgeführt ist. Weltweites Deployment und die Zusammenarbeit mit externen Partnern wird so optimalunterstützt. Alle Administrationsoberflächen (X-Docu
Production System und X-Docu WBT) werden über Browser bedient.
Das gesamte X-Docu System basiert auf der J2EE (Java EnterpriseEdition). J2EE ist eine plattformunabhängige Spezifikation, um Softwarebestandteile unterschiedlicher Hersteller miteinander operabel zu machen. J2EE als konsequent genutzter Standard garantiert Systemoffenheit, Konformität, Modularität und erheblichen Investitionsschutz. X-Docu kann somit in fast jedes firmeneigene Netzwerk integriert werden. Kundenanpassungen sind jederzeit flexibel realisierbar.
Alle Inhalte werden mit X-Docu als unabhängige Einheiten in Form von XML-Modulen verfasst. Diese werden an einer Stelle sinnvoll strukturiert abgespeichert, um sie zentral zur freien Kombination, mehrfachen Verwendbarkeit und weiteren Verarbeitung bereitzustellen. Aus diesem Pool einzelner Module können individuelle Projekte zusammengestellt und produziert werden. Auf diese Weise können Benutzerdokumentationen, Handbücher oder spezielle Dokumentationen bereitgestellt werden. Die Medienunabhängigkeit von XML erlaubt die Erstellung von PDF, RTF,DocBook, Webapplikationen, SCORM-kompatiblen Modulen oder JavaHelp. Neuestes Feature ist die Interaktion mit WIKIs zur Sicherung des Unternehmens-Know How. Modulare Struktur, Redaktionsrichtlinien, Organisationsstrukturen, neue Dokumentationsprozesse und XML mit den erforderlichen Tools, all dies sind Dinge, die in den bereits vorhandenen Dokumentationsprozess eventuell neu eingeführt werden müssen.
Lohnt sich dieser Aufwand überhaupt?
Die Antwort auf diese Frage lässt sich aus wirtschaftlicher Sicht leicht beantworten, wenn man die Größen Gesamtumfang der Information, Grad der Wiederverwendung, Anzahl der Sprachen, Überarbeitungszyklen und erforderliche Publikationsmedien kennt. Mit diesen Größen lässt sich berechnen, welcher wirtschaftliche Nutzen den oben genannten Aufwänden gegenübersteht. Wichtig ist hierbei, dass der Nutzen nicht alleine bei der erstmaligen Erstellung entsteht, sondern vor allem bei der Überarbeitung der Information.
Als Faustregel gilt: je umfangreicher die Dokumentation und je höherder Grad der Wiederverwendung, desto höher der wirtschaftliche Nutzen.
Beispielrechnungen können zeigen, dass bereits mit der
Ersterstellung der Unterlagen die Investitionskosten mindestens amortisiert, wenn nicht sogar deutlich überkompensiert werden. Diese positive Bilanz setzt sich dann mit jedem Update der Dokumentation fort. Einsparungen um die 100% sind an der Tagesordnung.
Daneben stehen übersichtliche, gut strukturierte Informationen und sprachliche Durchgängigkeit sowie ein geordneter Dokumentationsprozess als Plus auf der qualitativen Seite.
Stehen Sie also vor der Frage, ob Sie Ihren Dokumentationsprozess in der beschriebenen Form gestalten wollen, kommen Sie zunächst um eine Analyse Ihrer Informationen nicht herum. Diese Analyse hilft
Ihnen in jedem Fall, einen geeigneten Dokumentationsprozess zu finden und ist wirklich kein Hexenwerk. Der potentielle wirtschaftliche
Nutzen einer modularisierten Informationsstruktur ist die Mühe allemal wert.
