Jan
18
2010

Technische Dokumentation 2.0 – Teil 3: Dokumentationsportal statt Handbuchstapel

Und täglich grüsst das Murmeltier. Immer wieder klingelte bei mir das Telephon und ein Kollege stellte die übliche Frage: “Sag mal in welchem Handbuch finde ich eigentlich etwas zum Thema xyz ?”. Bei einem Umfang von mehr als 20 Handbüchern ist es mitunter schwer, den Überblick zu behalten. Also hiess es, die gerade angefangene Arbeit beiseite zu legen, dem Kollegen am anderen Ende kurz mit einem “Muss ich mal nachsehen, ich schicke Dir eine Mail.” zu vertrösten und dann auf die Suche zu gehen.

Gut, dass mir meine Vorfahren ein halbwegs brauchbares Gedächtnis mit auf den Weg gegeben haben. So dauerte es meist nur 10-20 Minuten, bis das richtige Handbuch (respektive PDF) ausfindig gemacht war, in dem es die gesuchte Passage gab.

Auf Dauer war das natürlich kein haltbarer Zustand. Arbeitszeit ist kostbar (sowohl meine als auch die meiner Kollegen). Es musste also eine Lösung her, die beiden Seiten half. Schauen wir doch mal, wie es andere machen. Einen guten Ansatz fand ich z.B. bei JIRA, die ein eigenes Dokumentationsportal betreiben.

jira docuportal

Die Idee, ein eigenes Dokumentationsportal aufzubauen, über dessen Suchmaschine die komplette Dokumentation online durchsuchbar ist, war geboren. Im nächsten Schritt wurde eine Matrix der Anforderungen erstellt, die das Portal erfüllen sollte. Gleichzeitig diente dieser Anforderungkatalog auch der Suche nach dem richtigen Tool für die Erstellung des Portals:

  • Online-Zugriff auf die komplette aktuelle Dokumentation (deutsch und englisch)
  • Thematische Gruppierung der Dokumentation (ähnlich einem Webkatalog)
  • Suchfunktion a´la Google
  • Suche über alle Dokumente möglich
  • Verwendung von boole´schen Suchoperatoren
  • Eingrenzung der Suche auf bestimmte Themenfelder
  • Online-Generierung von PDFs

Nach einer ersten Recherche fiel die Wahl schnell auf Apache Forrest einem Dokumentationsframework. Dieses Tool wurde genau für den Zweck entwickelt, automatisch aus XML-Dateien ein durchsuchbares Portal zu generieren. Unsere Dokumentation lag ja schon als XML vor, also perfekt.

Einige Anpassungen, außer neuen Stylesheets für die Corporate Identity, waren aber schon nötig. So musste zunächst ein XSL programmiert werden, dass die Umwandlung unser Dokumentation in das XML-Format von Forrest übernahm. Zum anderen wurde die verwendete Suchmaschine (Lucene) durch ein eigenes Script (basierend auf Hyper Estraier) ersetzt, dass besser auf unsere Bedürfnisse zugeschnitten war.

Das Ergebnis der ganzen Arbeit war dann ein Dokumentationsportal, dass diesen Namen auch verdient. Nicht nur, dass die komplette Dokumentation jetzt online für Mitarbeiter, Partner und Kunden durchsuchbar war. Wer weiterhin mit den PDF Handbüchern arbeiten wollte, konnte diese über das Portal bequem herunterladen.

Dokuportal

Der Aufwand für das Portal hat sich gelohnt. Die Anrufe, in denen gefragt wird, wo man denn welche Information finden kann, sind rapide zurückgegangen. Damit konnte eine Menge Zeit gespart werden. Das Portal wurde so gut angenommen, dass die Mitarbeiter jetzt wieder öfter bei mir anrufen, um Anregungen zur Verbesserung des Portals zu liefern ;o) Aber auch dafür wurde eine Lösung gefunden. Im Portal ist jetzt ein Feedback Button integriert, über den man problemlos online seine Anregungen abgeben kann.

Post to Twitter Post to Delicious Post to Digg Post to Facebook Post to MySpace

Download PDF
Written by Karsten Krumrück in: company,deutsch,general | Tags: , ,

2 Comments »

  • Reinhild Freitag

    Hallo,

    das klingt alles sehr interssant. Kann man ich das DokuPortal mal anschauen?

    Liebe Grüße
    R. Freitag

    Comment | 27 January 2010
  • Hallo Frau Freitag.

    vielen Dank für Ihren Kommentar. Zu Ihrer Frage: Das Dokuportal ist für Mitarbeiter, Partner und Kunden der SAPERION AG zugänglich. Wenn Sie zu einer dieser drei Gruppen gehören, können Sie gerne bei unserem Support einen Zugang zum Portal beantragen.

    mit freundlichen Grüßen

    Karsten Krumrück

    Comment | 27 January 2010

RSS feed for comments on this post. TrackBack URL

Leave a comment


+ three = 4

Theme: TheBuckmaker.com Web Templates | Bankwechsel Umschuldung, Iplexx IT Solutions