Gut angeleitet

Asciidoc(tor) und Sphinx im Praxistest

Nicht jedem liegt das Schreiben und Pflegen von technischen Dokumenten und Dokumentationen. Es erfordert Beharrlichkeit und Genauigkeit sowie ein Gespür für lesenswerten und verständlichen Text. Da sich zudem Software und die darin eingesetzten Verfahren recht häufig ändern, fällt es schwer, die begleitende Dokumentation synchron zu halten. Mit den beiden Werkzeugen Asciidoc und Sphinx vereinfachen Sie das Erstellen der Anleitungen, indem Sie im oder direkt neben dem Programmcode Dokumentation erstellen.

Asciidoc(tor) sowie Asciidoc FX waren schon des Öfteren Thema in LinuxUser. Jetzt gesellt sich Sphinx der Runde der Werkzeuge hinzu. Es wurde ursprünglich für die Dokumentation von Python entwickelt und kommt heute in fast