Jan
18
2010
2

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.

(more…)

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: , ,
Nov
20
2009
0

Technische Dokumentation 2.0 – Teil 2: Wiki statt Mail Ping Pong

Das Wissen der Mitarbeiter ist eines der wichtigsten Schätze eines Unternehmens. Leider ist es manchmal schwierig, diese Schätze zu heben, wenn man nicht weiss, wo sie liegen. Das führt oft dazu, dass lange Maildiskussionen geführt werden, ehe man weiss, wer das Wissen, das man gerade benötigt hat und in welcher Form es vorliegt.

Gerade wenn es um interne Systemabläufe in komplexen Client- Server Anwendungen geht, wie es bei SAPERION der Fall ist, geht bei einer solchen Suche viel kostbare Zeit verloren. Und das Ende vom Lied ist, dass man zwar für den Moment die Frage beantworten kann, aber 4-5  Monate später die gleiche Prozedur von vorne anfängt. In der Zwischenzeit hat man die Informationen wieder vergessen und kann sich nur dunkel daran erinnern, dass man diese Frage schonmal beantworten konnte. (more…)

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,language | Tags: , ,
Oct
05
2009
1

Technische Dokumentation 2.0 – Teil 1: XML statt Word

Wie schon im letzten Beitrag angekündigt, möchte ich die einzelnen Schritte, die bei der Umstrukturierung des Dokumentationsprozesses durchgeführt wurden näher beschreiben. Im ersten Teil geht es um die Umstellung des Basisformates von Word auf XML. Zunächst eine kurze Beschreibung des Dokumentationsprozesses vor der Umstellung auf XML: (more…)

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: , ,
Sep
21
2009
2

Technische Dokumentation 2.0

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

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 | Tags: , ,

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