2015-09-28 digital life Dokumentation prozedural vs. strukturell Wieder habe ich eine Klickanleitung in die Haende bekommen und mir wird bewusst, warum ich diese Art von Dokumentation so wenig leiden kann: Sie vermittelt nichts. Sie befolgt den Ansatz, jemanden einen genau definierten, fuer ihn zu schwierigen Vorgang ausfuehren zu lassen, ohne das Ziel, ihn zu befaehigen, den Vor- gang zu verstehen, auf dass er zukuenftig nicht mehr zu schwierig waere. Das ist wie die ``Entwicklungshilfe'' in Afrika: uneth- isch. Die Leute scheinen nicht genauer darueber nachzudenken, vor allem bei so etwas unbeliebtem und nebensaechlichem wie der Doku- mentation nicht. Hier geht es aber auch um die Lebensphilosophie: Was will ich mit meiner Arbeit erreichen? Nehme ich meine Mit- menschen fuer voll und halte ich sie fuer faehig? Schlechte Dokumentation beschreibt das Was und noch schlechtere das Wie. Gute Dokumentation beschreibt das Warum. Eng gesehen wuerde ich Klickanleitungen noch nicht mal zur Doku- mentation zaehlen, sie gehoeren eher zu den Geschwueren. Der ein- zige sinnvolle Anwendungsfall fuer sie ist das eingangs beschriebene Szenario: Man will jemanden dazu befaehigen, etwas zu tun, was seine Kompetenz uebersteigt, ohne dass er dabei seine Kompetenz erweitern soll. Alle anderen Anwendungsfaelle beduerfen anderer Dokumentationsstile. Statt des prozeduralen Ansatzes, bei dem die sequenzielle Abfolge von Arbeitsschritten beschrieben wird, sollte viel mehr der strukturelle Ansatz, bei dem die Zusammenhaenge und Abhaengig- keiten im Mittelpunkt stehen, gewaehlt werden. Dabei frage ich mich aber, ob zweiterer immer weniger verstanden wird. Naviga- tionssysteme sind eine Auspraegung des prozeduralen Ansatzes. Landkarten, dagegen, folgen dem strukturellen Ansatz. Wer lernen will, wie die Welt aussieht, der sollte keine Navigationssysteme nutzen. Diese werden aber immer verbreiteter und selbstver- staendlicher. Habe ich denn zu grosse Anforderungen an die Nutzer und an die Dokumentare? Natuerlich gehe ich davon aus, dass der Nutzer ver- stehen soll, was er tut. Vielleicht ist das schon unangemessen, da man von einem Durchschnittsmenschen, dem man ein Stueck Holz und einen Hobel in die Hand drueckt, auch nicht erwarten kann, dass er weiss, was er damit tut. Die Computerarbeiter machen aber keine Lehre, die sie befaehigen wuerde, mit ihrem Handwerkszeug und Arbeitsmaterial umzugehen. Und die Dokumentare? Selten wird die Dokumentation von faehigen Personen erstellt; meist bekommen die Praktikanten und Neulinge die ungeliebte Aufgabe aufgedrueckt. Diejenigen, die faehig sind, machen stattdessen ``wichtigere'' Arbeiten. Daraus folgt die schlechte Qualitaet der meisten Dokumentation. Dokumentieren, wie ich es im Sinn habe, ist jedoch keineswegs einfach. Es erfordert das umfassende Verstaendnis des zu dokumentierenden Systems. Die Dokumentation hat die Aufgabe, die in der Funktionalitaet mehr oder weniger versteckten Konzepte zu finden, freizulegen und in verstaendlicher und nachvollziehbarer Weise aufzubereiten. Damit ist die Dokumentation direkt wertschoepfend und ihre Ergebnisse haben eine Wirkung zurueck ins beschriebene System. Destillieren, Aufbereiten, Strukturdiagramme, Aehnlichkeit und Abgrenzung, Verstaendnis schaffen, Kuerze ... das sind Begriffe, die zu guter Dokumentation passen. Die schlechten Gegenstuecke will ich hier nicht aufzaehlen, nur einen Gedanken zu ihnen an- bringen: Ich wuenschte, es waere nicht so einfach und scheinbar kostenlos geworden, Screenshots einzufuegen. Ihre grosse Anzahl ist naemlich ein Indiz fuer schlechte Dokumentation. Das Vorhan- densein von originaeren Diagrammen, dagegen, ist ein Indiz guter Dokumentation. http://marmaro.de/apov/ markus schnalke