Wir brauchen eine Dokumentation

SplashTool wird mittlerweile innerhalb von Dahlem regelmäßig genutzt. Darüber hinaus kommt es in Kaiserslautern als Werkzeug für eine flächendeckende Analyse zum Einsatz. Bisher haben die Kommentare im Quelltext, sowie kurze unsortierte Erläuterungen zum Algorithmus für die Dokumentation der Funktionalität ausgereicht.

Dies reicht mittlerweile nicht mehr aus, da sowohl die zugrunde liegende Methodik, als auch die Anwendung nicht mehr ausschließlich für Menschen mit Python Vorwissen von Interesse sind: Wir brauchen eine Dokumentation.

Ich habe mich dazu entschlossen, meine etwas angestaubten Kenntnisse in LaTeX wieder aufzufrischen, die Dokumentation damit zu erstellen, und die LaTeX Quelldateien gemeinsam mit dem Modellquellcode in git zu verwalten. Das Grundgerüst ist angelegt, die Kapitel werden in den nächsten Wochen mit Inhalten gefüllt.

Update vom 04. Oktober: Die Dokumentation ist mittlerweile online und kann hier heruntergeladen werden.