knorr

 

 

Wer kennt nicht diese Situation als Dienstleister für Technische Dokumentation: man stellt sich beim Kunden vor und wie zufällig liegen ein paar Handbücher auf dem Schreibtisch, in die man doch mal einen Blick hinein werfen möge. Erstaunlicherweise sind die vorgelegten Handbücher in der Software-Dokumentation alle in gewisser Weise ähnlich.

Handbücher sind oft die kreativen Werke von kreativen Programmierern.

Typische Merkmale solcher Handbücher sind:

  • keine Konsistenz im Layout
  • keine Konsistenz in den Strukturen,
  • keine Konsistenz in der Terminologie,
  • keine Konsistenz bei den verwendeten Werkzeugen.

Es gibt nun die Kunden, die genau wissen, wie die Handbücher zukünftig aussehen sollen. Und es gibt Kunden, die lernen wollen, wie sie zukünftig etwas besser machen können. Und zur zweiten Sorte gehört zweifelsohne die Knorr-Bremse AG.

Nachdem der aktuelle Publikationsprozess und die daraus resultierenden Handbücher analysiert worden waren, ging man zunächst an die sukzessive Verbesserung der Handbücher, lag doch hier das dringlichste Problem.

Zuerst wurde eine Struktur entwickelt, die für alle in Zukunft zu erstellenden Handbücher angewendet werden soll. Kein leichtes Unterfangen, da es in den aktuellen Handbüchern praktisch keine Kapitelstruktur gab. Es wurde das in das Handbuch geschrieben, was als wichtig erachtet wurde und was dem Entwickler gerade einfiel. Das Argument, dass eine vorgebene Struktur die Autoren dabei unterstützt, die benötigten Inhalte zusammenzutragen, ohne dabei befürchten zu müssen, Wichtiges zu vergessen, förderte die Suche nach einer geeigneten Struktur ungemein. Plötzlich konnten in den bestehenden Handbüchern Gemeinsamkeiten entdeckt werden, die bisher nicht beachtet worden sind. Und mit der neuen Struktur wurde sofort offensichtlich, was in welchem Handbuch fehlte.

Danach wurde ein Style Guide entwickelt, um dann die bestehenden Handbücher exemplarisch mit Hilfe des Style Guides migrieren zu können. Das Thema des Style Guides lässt sich mit einem Wort zusammenfassen: Konsistenz.  Mangelnde Konsistenz ist oft der Ausdruck davon, dass dem Autor nicht ausreichend Hilfen angeboten werden, damit er sich auschließlich um die Inhalte kümmern kann und nicht noch all die anderen Dinge, seien es die Formatierungen, Begriffe und Formulierungen.

Parallel zur Analyse der bestehenden Dokumentation und der Entwicklung eines Style Guides wurde evaluiert, welche Tools zukünftig für die Erstellung der Dokumentation verwendet werden sollen. Von XML-Editoren über Autorenprogrammen bis hin zu einfachen Textverarbeitungsprogrammen wurde alles untersucht. Letzten Endes fiel die Entscheidung dahin gehend,  weiterhin Microsoft Word zu verwenden, jedoch nicht wie bisher mit einer beliebigen Dokumentenvorlage, in der Inhalte in beliebiger Form erfasst und bearbeitet werden können, sondern auf Basis eines Templates, in dem sowohl die Kapitelstruktur, die Formatvorlagen für die funktionalen Einheiten als auch exemplarische Text- und Bildelemente enthalten sind.

Mit dem neuen Word-Template und dem neuen Style-Guide wurden dann schließlich die bestehenden Handbücher migriert. Ein angenehmer Nebeneffekt der nun konsistenten Handbücher war es, dass die Word-Dokumente mittles Doc-To-Help problemlos in andere Formate für Online-Hilfen zu überführt werden konnten.

Oft sind gar nicht die großen chirugischen Eingriffe notwendig, damit die Technische Dokumentation wieder zum „Fließen“ kommt. Wird an den richtigen Stellschrauben gedreht, kann mit kleinem Einsatz große Wirkung erzielt werden.