Für die technische Doku bin ich nun ein absoluter Anhänger der Topicorientierung. Der Anspruch ist hier nicht für eine bestimmte Ausgabe zu schreiben, sondern die Bedienung eines Produkt zu beschreiben und ggf. die Hintergrundinformationen, die man dazu benötigt. Aus diesen Beschreibungen kann man sich später die verschiedensten Dokumentypen zusammenbauen, vom Schnell-Start-Guide bis zum Kompletthandbuch.
Nun starten die meisten Leute eine traditionelle Doku (also ein klassiches Word – oder Framemaker-Handbuch) damit ein Inhaltsverzeichnis zu erstellen. Im Endeffekt ist das auch nicht der schlechteste Ansatz, nur funktioniert er mit Topicorientierung zusammen nicht so gut, wie ich feststellen konnte.
Denn so bald man anfängt sich auf die Endausgabe, also z.B. das Benutzerhandbuch, zu konzentrieren, fängt man an, die Topics so zu schreiben, dass sie in die Struktur reinpassen, die man sich vorher zusammengestrickt hat. Aber so passiert es eben auch leicht, dass sie später in andere Strukturen, für die man das Topic braucht, eben nicht reinpassen. Man fällt selbst so schnell in die lineare Struktur hinein, dass man die Topicorientierung sehr leicht aus den Augen verliert.
Deshalb heißt es für mich ganz klar: zuerst kommt das Topic und später irgendwann die Struktur in der es zufällig auch existiert.