Sorgenkind gedruckte technische Dokumentation
Viele Unternehmen tun sich mit der Produktion technischer Dokumentation, also zum Beispiel Installations-, Bedienungs-, Wartungs- und Serviceanleitungen, schwer. Benötigte Informationen werden an unterschiedlichen Stellen gehalten und liegen in unterschiedlichen Formaten vor. Diese zusammenzuführen gestaltet sich aufwendig und langwierig.
Einmal gedruckt lässt sich der Inhalt eines Dokuments nicht mehr ändern. Produktinnovationszyklen werden jedoch immer kürzer. An Produkten werden Verbesserungen vorgenommen, Fehler korrigiert und neue Leistungsmerkmale eingeführt. Jede Änderung erfordert einen Neudruck des Dokuments. Oftmals müssen die Dokumente vorab noch von einer Werbeagentur für den Druck aufbereitet werden.
Das Gesetz schreibt vor, dass die technische Dokumentation in der jeweiligen Landessprache vorhanden sein muss. Wer zum Beispiel seine Produkte innerhalb Europas vertreiben möchte, ist sehr schnell mit mehr als zwei Dutzend Sprachen konfrontiert. Dies stellt nicht nur in puncto Übersetzung eine Herausforderung dar. In Kombination mit der permanent notwendigen Aktualisierung der Dokumente ist der Druck ein erheblicher Kostenfaktor.
Die Zukunft liegt im Internet
Die Entwicklung vom Print hin zum Internet schreitet auch bei der technischen Dokumentation unaufhaltsam voran. Bei der Internetlösung mit Hilfe eines Wikis werden die Dokumente auf einem zentralen Server als Web-Seiten aufgebaut und gespeichert. Sowohl die Redakteure, als auch die Benutzer der technischen Dokumentation (im Folgenden "Benutzer" genannt) greifen über das Internet auf die Dokumente zu. Der Benutzer kann die Dokumente nur lesen, der Redakteur hingegen kann die Dokumente auch bearbeiten.
Besser finden und verstehen
Der Umstieg auf Online-Dokumentation spart nicht nur Zeit und Kosten, sondern eröffnet auch völlig neue Möglichkeiten für die Unterstützung der Benutzer. In die Dokumente lassen sich Links zu externen Informationsquellen einbauen. Zusätzlich können an einzelne Dokumente Dateien angehängt werden, die ergänzende oder vertiefende Informationen, wie zum Beispiel Videofilme, beinhalten. Der Benutzer wird also wesentlich umfassender und multimedial informiert.
Ein Online-Dokument lässt sich mit einer Suchmaschine einfach durchsuchen. Hier gibt es verschiedene Ansätze. Einzelne Dokumente können mit Schlüsselwörtern beschrieben werden. Oder der Benutzer durchsucht den kompletten Inhalt des Dokuments einschließlich der angehängten Dateien.
Die Lösung: ein Wiki
Ein Wiki ist die kostengünstige und leistungsfähige Lösung zur Erstellung technischer Dokumentation im Internet. Ein Wiki (hawaianisches Wort für "schnell") ist ein Content Management System mit Dokumentenmanagementfunktionalität und Unterstützung von Teamarbeit. Die Wiki-Software läuft in der Regel auf einem Webserver. Der Zugriff erfolgt über das Internet mit einem Browser. Das Wiki ermöglicht Autoren, von unterschiedlichen Standorten aus gemeinsam an Dokumenten zu arbeiten. Eines der bekanntesten Wikis ist Wikipedia, die freie Enzyklopädie im Internet.
Leistungsmerkmale eines Wikis
- Ein gutes Wiki besitzt einen leistungsfähigen Wysiwyg-Editor zur Bearbeitung der Dokumente. Dieser zeigt den Inhalt direkt so an, wie er später im Wiki dargestellt wird.
- Über Templates lassen sich Dokumente besonders schnell und effektiv erstellen. Dabei ist sichergestellt, dass keine Inhalte vergessen oder an falscher Stelle platziert werden.
- Ein Wiki führt automatisch eine Versionierung durch. Alle Versionen werden archiviert. Änderungen können somit wieder rückgängig gemacht werden.
- Seiten werden in einer hierarchischen Verzeichnisstruktur angelegt. So kann die gewohnte Klassifizierung im Wiki abgebildet werden (z.B. Kategorien - Produktgruppen - Produkte).
- Ein Wiki besitzt eine leistungsfähige Suchfunktion
- Ein Wiki ermöglicht eine effektive und leistungsfähige Verwaltung der Sprachversionen
Ein Wiki besitzt darüber hinaus Funktionen, die das Arbeiten im Team erheblich erleichtern:
- Über eine Rollen- und Rechteverwaltung kann sehr flexibel eingestellt werden, wer auf welche Bereiche Zugriff hat und ob ein Benutzer Informationen nur sehen oder aber auch bearbeiten darf.
- Es können automatische Benachrichtigungen auf einzelnen Seiten oder ganzen Bereichen eingerichtet werden. Das Wiki verschickt dann automatisch eine E-Mail oder einen RSS-Feed, wenn ein Dokument geändert oder eine neue Anlage überspielt wurde.
- Stehen Dokumente zur Freigabe an, wird der Verantwortliche automatisch per E-Mail oder RSS-Feed darüber informiert.
Ausblick
Technische Dokumentation im Internet ist bei Open-Source-Software bereits heute Standard. Über die ganze Welt verteilte Teams erstellen Tutorials, Referenzhandbücher, Beispielcodes und vieles mehr. Diese Dokumente ermöglichen Benutzern, die Software effektiver einzusetzen und haben so auch zum Siegeszug der Open-Source-Software beigetragen.
Es wird immer schwerer, sich mit Produkt- oder Anlagenleistungsmerkmalen von seinen Mitbewerbern zu unterscheiden. Das Hauptaugenmerk liegt daher in Zukunft immer mehr auf dem Service. Und genau hier bietet die Erstellung, Aktualisierung und Bereitstellung technischer Dokumentation über ein Wiki einen echten Wettbewerbsvorteil.
