Beispiel: AuthorIT einführen

Aufgabe

Bestehende Dokumente aus den Datenformaten HTML und DOC sollen einheitlich gepflegt werden. Dafür wurde das Autorensystem AuthorIT eingeführt. Das Autorensystem muss für die Dokumentationsaufgabe des Kunden eingerichtet werden. Bestehende Dokumente sollen importiert und weiter bearbeitet werden.

Zielsetzung

Einführung einer Single-Source-Lösung, um für alle Dokumente gedruckte Handbücher, HTML- oder Onlinehilfen erstellen zu können.
Außerdem soll mit dem Umstieg auf AuthorIT der Dokumentationsprozess standardisiert werden. Mehrere Redakteure sollen gleichzeitig an einer Dokumentation arbeiten können.
Folgende Fragestellungen werden berücksichtigt:

• Wie muss die Library aufgebaut werden, um effektives Arbeiten und eine kurze Einarbeitungszeit zu ermöglichen?
• Wie soll die Rechtevergabe aussehen, um die richtige Balance zwischen Sicherheit und komfortablem Arbeiten zu finden?
• Welche Dokumente sind so aktuell, dass sich ein Import lohnt?

Umsetzung

Analyse

Alle vorhandenen Dokumente werden systematisch analysiert. Folgende Punkte werden geprüft:

• Strukturierung und Gliederung der Dokumente
• Formatierung der Dokumente
• Aktualität der Dokumente
• Benennungssystematik für Dateien
• Informationsarten und -klassen
• Vollständigkeit

Ergebnis der Analyse

Aufgrund der Analyse stellt sich die Ausgangssituation wie folgt da:

• Dokumente können aussortiert werden.
• Die Informationen sind gut strukturiert.
• Es gibt Gliederungsebenen durch Überschriften.
• Es gibt redundante Texte.
• Dreißig Prozent der Texte bleiben immer gleich, da es sich um Basiswissen handelt.
• Das Layout ist uneinheitlich.
• Die Formatvorlagen "Standard" wird immer wieder verwendet.
• Die Auszeichnungen im Text sind uneinheitlich.
• Das CI wird nicht immer eingehalten.

Standardisierung festlegen

Um den Dokumentationsprozess zu optimieren, werden Standardisierungen festgelegt und in einem Dokumentationsleitfaden dokumentiert. Folgende Schwerpunkte werden festgeschrieben:

• Seitenlayout
• Formatvorlagen
• Auszeichnungsregeln
• Grafikaufbereitung
• Basisgliederung
• Informationsklassen
• Variablen
• Dateibenennung und Objektindexierung
• Bildaufbereitung
• Terminologieliste
• Release states der Objekte für AuthorIT
• Festlegung der Rechte der einzelnen Redakteure
• Vorgaben für die AuthorIT Templates

AuthorIT einrichten

Zuerst wird eine Bibliothek angelegt. Anschließend wird mit der Administrationssoftware von AuthorIT Benutzergruppen und -rechte festgelegt. Die Release states werden nach den vorher getroffenen Festlegungen angepasst und erweitert. Die Basisvariablen werden erstellt.
In der Bibliothek werden die benötigten Vorlagen (Templates) angelegt. Jetzt ist AuthorIT so weit vorbereitet, dass die Texte systematisch importiert werden können.

Um den Export nach Word zu ermöglichen, muss eine Dokumentenvorlagen erstellt werden. Seitenlayout und Formatvorlagen werden nach den Vorgaben aus dem Dokumentationsleitfaden eingerichtet.

Import der Dateien

In AuthorIT können Importprofile mit Regeln festgelegt werden. Einmal erstellt ist der Import der Dokumente einfach möglich.
Die Dokumente werden je nach eingestellter Regel in einzelne Textobjekte gesplittet und Formatvorlagen zugewiesen. Zu jeder Grafik wird automatisch ein Grafikobjekt erzeugt.

Nach dem Import können die Texte in AuthorIT weiterbearbeitet und strukturiert werden.

Ergebnis

Die Inhalte der Dokumentation sind völlig von der Form ihrer Ausgabe getrennt. Einige Mausklicks reichen, um die Dokumentation als gedrucktes Dokument oder als Onlinehilfe bereitzustellen. Mehrere Autoren können bequem und sicher in der Library arbeiten. Mit Hilfe der Statusanzeige wissen die Redakteure immer, welche Objekte noch bearbeitet werden müssen und welche schon freigegeben sind.