Sep
21
2009

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

2 Comments »

  • Das klingt wirklich sehr interessant. Ich freue mich auf eine spannende Fortsetzungsgeschichte.

    Herzliche Grüße vom Rheinufer!

    Comment | 5 October 2009
  • Danke für die Blumen. Der nächste Teil der Fortsetzungsgeschichte (XML statt Word) ist schon erschienen. Ich hoffe, es bleibt für Sie weiter spannend ;o)

    Viele Grüße aus dem sonnigen Berlin

    Comment | 9 October 2009

RSS feed for comments on this post. TrackBack URL

Leave a comment


+ three = 8

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