Schreibarbeit

28. Mai 2020

Seit Jahren tun die Klassenbibliotheken Transit und BaseLink seit ihrem Entstehen ihren Dienst in verschiedenen Apps. Dass sie sich in der Zeit kaum verändert haben ist ein Zeichen für ihre Praxistauglichkeit.

Eines fehlte aber bis jetzt: Eine vernünftige Dokumentation.

Eine brauchbare Dokumentation ist noch einmal so aufwendig zu erstellen wie das von ihr beschriebene Werk. Nun kam aber zweierlei zusammen: Eine neue Begeisterung für das Werkzeug Asciidoctor und etwas Muße. Zu Ersterem wird demnächst noch mehr erscheinen.

Gemeinsam waren es ideale Bedinungen, um endlich abzuschließen, was schon zu lange in diesem Punkt unfertig war. Die Anleitungen sind fertig:

• Anleitung Transit (HTML) (PDF)
• Anleitung BaseLink (HTML) (PDF)

Eine Bemerkung am Rande: Erst beim Schreiben fiel auf, welche Aspekte sich mit der Verwendung der Werkzeuge alle verbinden. Einiges war bei der Nutzung wie selbstverständlich da. Erst bei der Dokumentation entpuppten sich Zusammenhänge, die für eine konsistente Darstellung ebenfalls noch beschrieben sein wollten.

Ein gutes Gefühl, einen Schlussstrich unter diese Kapitel ziehen zu können, insbesondere, wo in Zeiten von Cloud-Technologie und Microservices schlanke Lösungen mehr im Fokus stehen.