SAPERION Blog

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.

(more…)

Heute leben wir in Zeiten, in denen das Internet allgegenwärtig ist und man zuerst bei Google und Wikipedia nachschlägt, wenn man etwas wissen will. Diesem Umstand muss auch die technische Dokumentation von Software Rechnung tragen. Vorbei sind die Zeiten, als dicke schwergewichtige Folianten ausgeliefert wurden, durch die man sich mühsam hindurcharbeiten musste, um die richtigen Informationen zu finden. In der Dokumentationsabteilung von Saperion wurde in den letzten Jahren daher eine grundlegende Umstrukturierung des Dokumentationsprozesses vollzogen.

Heute basiert der Dokumentationsprozess von Saperion auf drei Säulen:

• Docbook XML als Basisformat
• Internes Wiki für die Zusammenarbeit mit Entwicklern und als Systemdokumentation
• Online Portal für die Recherche in der Dokumentation

Bis zu diesem Stand des Dokumentationprozesses war es ein langer und schwieriger Weg, der in den nächsten Wochen hier beschrieben werden soll. Im einzelnen umfasste die Umstrukturierung des Dokumentationsprozesses diese Etappen:

1. XML statt Word
2. Wiki statt Mail Ping Pong
3. Dokumentationsportal statt Handbuchstapel