Dokumentation mit DocBook

Dokumentation mit DocBook

Posts 1-4 of 4
  • Markus Kamp
    Markus Kamp    Group moderator
    The company name is only visible to registered members.
    Software-Doku für Versionen verschiedener Betriebssystem-Platformen
    Sehr geehrte DocBook-Spezialisten,

    als Jungunternehmer (Selbständiger IT-Consultant mit BWL/Wirtschaftsinformatik-Hintergrund) bin ich derzeit in der Situation, für ein Software-Produkt die Software-Dokumentation schreiben zu müssen. Damit ist in erster Linie natürlich die Dokumentation für die End-Anwender der Software (Kunden) gemeint. Gleichwohl soll das Werk jedoch auch über die Website des Unternehmens im PDF-Format zum Download angeboten werden.

    Eine Besonderheit an der Software ist, dass sie demnächst auch für ein anderes Betriebssystem angeboten werden soll. Auf einer Website habe ich gelesen, dass man mit DocBook sozusagen in einem Werk produkt-spezifisch schreiben kann. Das soll heißen, dass ich ein Handbuch schreiben kann und je nachdem über welchen Weg man das Buch liest werden z. B. die Abbildungen für die jeweilige Betriebssystemplatform angezeigt. So könnte man doch sicherlich viel Arbeit sparen?!?

    Wer kann mir Tips dazu geben. Sicherlich werde ich am Anfang noch ganz normal die Doku mit einer Textverarbeitung verfassen müssen, doch ich finde die Idee reizvoll, sozusagen den "Mehrwert" meiner Arbeit in der Hinterhand zu haben und irgendwann aus der Tasche zu zaubern ;-)

    Hier im Forum wurde ja auch gesagt, dass wenn in Bezug auf den Satz einer Dokumentation höhere Ansprüche gestellt werden, dass dann eine Version erzeugt werden kann die von einem DTP-Spezialisten dann "aufgemöbelt" werden kann. Kann diesen Aspekt evtl. auch noch mal kurz jemand "beleuchten"?

    Vielen Dank im voraus.

    Mit freundlichen Grüßen aus Berlin

    Markus Kamp
    • 09 Feb 2007, 12:11 am
  • Markus Kamp
    Markus Kamp    Group moderator
    The company name is only visible to registered members.
    Re: Software-Doku für Versionen verschiedener Betriebssystem-Platformen
    ... schade keine antwortet mir?!? - Hab' ich was falsch gemacht?

    Nette Grüße

    Markus Kamp
    • 02 Mar 2007, 03:11 am
  • Thorsten Born
    Thorsten Born    Premium Member
    The company name is only visible to registered members.
    Re^2: Software-Doku für Versionen verschiedener Betriebssystem-Platformen
    Hallo Herr Kamp!

    So wie ich aus der Ferne Ihre Situation einschätze - also keine regelmäßigen, aufwendigen Dokumentationen/Anleitungen... - denke ich, dass docbook vielleicht doch etwas zu aufwendig in der Einarbeitung für sie ist. -. Gerade im kleinen Unternehmen (oder gar bei Einzelkämpfern, die nur Texte schreiben wollen).

    Für solche Fälle, wie der von Ihnen beschriebene, würde ich - auch wenn es hier off-topic ist - Programme wie doc2help vorschlagen. Es handelt sich dabei um single-source-Anwendungen mit der Möglichkeit, Texte so zu markieren, dass verschiedene Ausgabe-Versionen und auch Formate erzeugt weden können. In der Regel basieren diese Programme u.a. auf Makros für Word und sind somit recht einfach in der Einarbeitung - vor allem, wenn es sich bei den Anwendern nicht um "XML-Experten", sondern um "Autoren" handelt.

    Weitere Fragen gerne auch im direkten Kontakt.
    Natürlich können wir auch nochmals über einen docbook-Einsatz in ihrem Falle sprechen... ;-)

    Viele Grüße,
    Thorsten Born
    • 04 Mar 2007, 10:16 am
  • Markus Kamp
    Markus Kamp    Group moderator
    The company name is only visible to registered members.
    Re^3: Software-Doku für Versionen verschiedener Betriebssystem-Platformen
    Vielen Dank für den Hinweis - Ich werde mich damit mal beschäftigen und komme dann ggf. gern auf Ihr Kontakt-Angebot zurück.

    Mit freundlichen Grüßen

    Markus Kamp
    • 07 Mar 2007, 08:27 am