GUI gegen TUI: Man kann die Dokumentation direkt zur Konfiguration schreiben
Fast jedes mir bekannte Format für Konfigurationsdateien erlaubt Kommentare. Sinnvoll genutzt, kann man sich externe Dokumentation damit fast vollständig sparen: Man schreibt die Dokumentation einfach dorthin, wo derjenige, der die Konfiguration verstehen möchte, sowieso hineingucken muss. Direkt in das Konfigurationsfile.
Für den Dokumentierenden hat das den zusätzlichen Vorteil, dass man die Dokumentation bei der Ausführung von Konfigurationsänderungen gleich mit offen hat. Das erleichtert die Kenntnisnahme der Doku (sprich: man guckt nicht erst in die Doku, wenn man ohne nicht mehr weiterkommt), und außerdem ist man weniger unmotiviert, die Konfigurationsänderung zu dokumentieren.
Nachteil: Wenn Leute, die mit dem System eigentlich nichts zu tun haben, die Dokumentation sehen wollen, muss man diesen eine Brücke bauen, die zum Beispiel aus einem kompletten Export der Konfiguration auf ein Dokumentationssystem bestehen kann. Das kann vollautomatisch geschehen, macht also keine Arbeit; allerdings ist so eine Dokumentation den typischen Auditoren und Entscheidungsträgern in aller Regel zu wenig bunt und entspricht nicht der vorgeschriebenen CI.
Zum Vergleich die übliche Vorgehensweise beim GUI: Man erstellt Word- oder HTML-Dokumente mit Millionen von Screenshots. Oder man tippt sich einen Wolf. Und es ist nichtmal sichergestellt, dass die Dokumentation noch aktuell ist, denn das Anpassen der Dokumentation erfordert mehrere zusätzliche Arbeitsschritte. Dafür ist's bunt und CI-konform. Und doppelt so teuer.
Plus fürs TUI.
Trackbacks
No Trackbacks
Comments
Display comments as Linear | Threaded
Jörg on :
Wobei die Art der Bearbeitung einer Konfiguration natürlich überhaupt nichts mit TUI vs GUI zu tun hat.
Marc 'Zugschlus' Haber on :
Erklär mir das mal bitte.
Jörg on :
Nicht jedes GUI Programm hat nur eine GUI-Konfigurationsschnittstelle
flawed on :
Jegliche Mechanismen, die darauf abzielen, dass die Dokumentation direkt neben der Konfiguration steht, leben aber davon, dass Doku und Konfiguration bei allen Bearbeitungswegen gleichermaßen sichtbar sind.