Handbuch schreiben ohne Textverarbeitung - mit Adonis XML Import

Testen Sie igumbi kostenlos für 30 Tage. Eine Kreditkarte ist nicht erforderlich.

Bei neuen und interessierten Kunden kam in letzter Zeit öfter die Anfrage nach einem Handbuch für die igumbi Hotelsoftware. Nun ich bin nicht gerade der größte Fan vom Handbuchschreiben - besonders nicht mit einer Textverarbeitung.

igumbi Handbuch - Der erste Wurf mit Adonis CE und XML Export und Nokogiri Import in die Website als strukturiertes Dokument

Es fängt meistens recht einfach an. Aber derartige Dokumentationen wachsen und wachsen und Elemente müssen später reorganisiert werden. Man kommt drauf dass es in kleineren Häppchen verdaulicher und praktischer wird. Und dann wird es echt grauenhaft mit einer Textverarbeitung.

Wichtig ist, dass am Ende eine Dokumentation herauskommt in der man sich schnell orientieren und einlesen kann. Auf die aktuelle Frage soll rasch eine einfach beschriebene Antwort gefunden werden.

Für die Wartung der Dokumentation im Laufe der Zeit sollten Erweiterungen und Änderungen keinen großen Aufwand verursachen. Vor allem soll das Layout nicht auseinander fallen.

Um diese Anforderungen zu bewältigen fiel meine Wahl fiel auf Adonis Community Edition (Adonis CE) der Wiener Firma BOC. Adonis ist eine Software zum Dokumentieren von Geschäftsprozessen. Ich hatte in der Vergangenheit ein Prozessteam für das Billing und Abrechnungsthema in einem Telekommunikationsunternehmen geleitet. Wir hatten damals das Vorhaben unsere ISO 9001 Zertifizierung für den Billing Prozess zu erneuern, und mussten eine übarbeitete Dokumentation. Was mich damals beeindruckt hatte, war die Geschwindigkeit mit der es möglich war Abläufe High Level zu erfassen und zu modellieren - die Notwendige Detailtiefe kam dann meist dazu als wir in der Gruppe einen Prozess besprachen und es wurden gemeinsam treffende Formulierungen gefunden. Binnen drei Wochen hatten wir ein brauchbares Gerüst, und eine Basis für eine lebendige Dokumentation.

Für das aktuelle Thema, ein Handbuch für neue Nutzer der igumbi Lösung zu schaffen habe ich habe ein Hauptprozessmodell erstellt und angefangen die ersten Business Prozess Maps zu erstellen.

Mir ist aber auch recht wichtig dass die Dokumentation gut aussieht und es für meine Benutzer eine Freude ist das Handbuch zu verwenden. Adonis unterstützt derzeit die Ausgabeformate XML, HTML sowie RTF um die Dokumentation typischerweise in einem Intranet zu publizieren. Aber die Form der Dokumentation sieht schon etwas betagt oder zu "corporate" aus. Adonis verfügt jedoch über die Möglichkeit die Daten der Modellierung als ein reines XML File zu exportieren. Dieses XML Dokument habe ich dann mit der Scriptsprache Ruby und dem XML Parser Nokogiri (ein Ruby GEM) herrlich umwandeln können um die Inhalte in die igumbi Website einzuspielen.
In weiterer Folge werde ich wahrscheinlich noch eine PDF Variante des igumbi Handbuchs bereitstellen.

Das igumbi Handbuch ist zwar noch Work in Progress (und strotzt wahrscheinlich vor Rechtschreibfehlern ;) ). Aber der Schreib- und Produktionsablauf ist recht angenehm.
Ich plane auch die Diagramme, die Adonis generiert, mittels Javascript grafisch aufzubereiten.

Author: , igumbi.com . Ich bin auf twitter zu finden: @smtm, und als roland.oth auf Facebook

igumbi Hotelsoftware - jetzt unverbindlich probieren

Hotelsoftware Demo: System Übersicht der Funktionen

igumbi ist eine online Hotelsoftware mit einem einfachen und schnellen Buchungstool für Ihre Website.

Wir steigern Ihre provisionsfreien Direktbuchungen. Sie sparen Zeit und haben auch mit der iPhone App Zugriff auf Ihre Daten.

Testen Sie igumbi für 30 Tage. Eine Kreditkarte ist nicht erforderlich.

1-300x250-hand-bp-hotel

Kommentare

Kommentar hinzufügen

 erforderlich

 erforderlich, wird nicht publiziert