You are here

Opensource als Basis für automatisierten Dokumentationsprozess

In unserer Firma haben wir einen langen Prozess durchgemacht von der Erstellung der Softwaredokumentation mit Word hin zu einem automatisierten Dokumentationsprozess auf Basis von Docbook. Mit der alleinigen Umstellung des Formats ist es nämlich meist nicht getan, es ist nur der Anfang.

Wenn man erstmal mit der Optimierung des Dokumentationsprozesses beginnt, kommt eins zum anderen. Würde mich interessieren, welche Erfahrungen andere Redakteure gemacht haben. Bei uns hat der ganze Prozess ca. 1,5 Jahre gedauert. Bedauert haben wir den Schritt nicht, Word fasse ich jetzt nur noch an, wenn es unbedingt sein muss. Unser System besteht jetzt aus folgenden Open Source Komponenten:

  • Subversion (Versionsverwaltung)
  • DocBook XML (XML Schema)
  • Serna Free (graphischer XML Editor)
  • Saxon (XSL-Prozessor)
  • Apache FOP (PDF-Generierung)
  • Apache Forrest (Dokumentations-Framework für Online-Portal)
  • Apache (Webserver)
  • Hyper Estraier (Suchmaschine für Online-Portal)
  • Python (Scriptsprache für Steuerungsscripts)
  • MoinMoin (Wiki für Systemdokumentation)

Bin gerade dabei, meine Erfahrungen in unserem Blog niederzuschreiben. Also wen es interessiert: Saperionblog

AddThis: 

Comments

Hallo!

Dass ihr schon an der Umstellung des Formats arbeitet finde ich wirklich toll. Würde mich auch wirklich interessieren wie ihr mit der Optimierung vorankommt. Dass das nur 1,5 Jahre gedauert hat ist auch ziemlich cool!

Lg Fabian

Hallo Fabian,

die Optimierung ist abgeschlossen und das System läuft. Die Umgewöhnung der Entwickler und Redakteure auf die Arbeit mit XML hat eine Weile gedauert, schließlich ist der Mensch ein Gewohnheitstier. Wenn das System erstmal läuft, muss man es eigentlich nicht mehr anfassen. Wichtig ist aber, dass man von Anfang an eine Dokumentation zu dem Prozess mitführt und ständig aktualisiert.

Ein Dokumentationshandbuch sollte eigentlich in keiner Doku-Abteilung fehlen

LG

Karsten

Theme by Danetsoft and Danang Probo Sayekti inspired by Maksimer