Mal eben ne schnelle Nummer gefällig!? 18.05.200521.11.2017 Nicht alles im Leben, was auf den ersten Blick einfach erscheint, ist auch auf lange Sicht zweckmäßig und für alle Beteiligten von Nutzen. In der technischen Dokumentation hält sich so auch eisern die Ansicht, dass nummerierte Abschnitte und Kapitel dem Benutzer eine klare Orientierung und Benutzbarkeit der Dokumentation ermöglichen. Bevor es zu Missverständnissen kommt: Es geht hier um eine aufgeblähte Nummerierung, nicht um eine zweckmäßige. Handlungen, die einer bestimmten Reihenfolge genügen sollen und die teilweise rekursiv ausgeführt werden („Falls das Lämpchen leuchtet, wiederholen sie Schritt 4.“) stehen hier nicht zur Debatte. Auch sind Kapitelnummern sinnvoll, wenn sie sich in der Seitenzahl widerspiegeln: Kapitel 3 beginnt mit der Seiten eben auch bei 3-… Meist werden vier Bereiche genutzt, seine Zahlen „an den Mann“ zu bringen: Abschnitts- und Kapitelnummerierungen Handlungsanweisungen Bildnummerierungen Tabellennummerierungen Unabhängig von der Software werden dazu Zahlen- und Buchstabenkonstrukte erzeugt (manchmal auch beides kombiniert), die der verschachtelten und komplexen Materie soweit als möglich gerecht werden sollen. Es hat sich dazu schon herumgesprochen, dass eine Abschnittstiefe, die mehr als drei Nummernkreise umfasst („1.2.2“), vom Leser nicht mehr recht wahrgenommen wird, da er sich die Zahlenfolge ab vier Ziffern nicht mehr richtig merken kann. (Auf diese Unsitte gehe ich daher nicht ein.) Um das Problem zu umgehen, werden jedoch häufig zusätzlich Begriffe („Abbildung“) verwendet, die insbesondere in den Bildnummerierungen ihr Unwesen treiben („Abbildung 1.2.2.a“). Zusätzlich werden die Tabellen entsprechend erfasst („Tabelle 1.2.2.a“), von den Handlungen ganz zu schweigen. Aber schon bei den Tabellen beginnt die Ungemach, denn die Frage entsteht, ob sie wie Bilder nummeriert oder doch lieber eine eigene Nummerierung haben sollen. Begründet wird dieser Aufwand schließlich mit dem Hinweis, dass der Leser/Benutzer die Nummerierungen benötige, um sich rascher zurecht zu finden, als ihm dies mit Kapitel- oder Abschnittstiteln möglich sei, da die Zahlen kürzer sind. Daher werden dann die Querverweise neben den obligatorischen Seitenzahlen mit den passenden Zahlen geschmückt, um Ungetüme entstehen zu lassen, die sich wie die Lottozahlen lesen: „Siehe Abbildung 1.2.2.a und Tabelle 1.2.2.a.1 auf Seite 3 – 46“. Haben Sie sich das jetzt merken können? Wo schauen Sie nach? Auf Seite 3 – 46? Richtig! Und warum? Weil das an letzter Stelle steht, mithin im angesprochenen Kurzzeitgedächtnis noch haften geblieben ist. Die anderen Zahlen haben sie überlesen. Ist ja nicht schlimm, Sie finden die Stelle wahrscheinlich trotzdem, wenn es nur ein Bild und eine Tabelle auf dieser Seite gibt. Falls es jedoch mehrere Bilder geben sollte, müssten Sie wieder zurück blättern zum Querverweis. Pech, wer die Seite schon zugeschlagen und den Finger rausgenommen hat… Um das zu umgehen, versucht man, parallel zum Zahlengedächtnis das Begriffsgedächtnis des Lesers zu aktivieren: Neben der Abschnittsnummer den Titel im Querverweis zu nennen („Siehe Abbildung 1.2.2. „Wasserpumpe“ und Tabelle 1.2.2.a.1 „Legende“ auf Seite 3 – 46″). Nun aber schütten wir das Kind mit dem Bad aus: Der Querverweis wird nämlich so lang, dass ihn der Leser überhaupt nicht mehr versteht, denn er muss jetzt die leicht zu merkenden Inhalte (Abschnittstitel und Seitenzahl) aus einem Dickicht herausklauben, bevor er zu blättern beginnen kann. Das ist nicht benutzerfreundlich. Also streichen wir den Querverweis auf die benötigten Informationen wieder zusammen („Siehe Abbildung „Wasserpumpe“ auf Seite 3 – 46″). Na prima, geht doch. Wozu aber habe ich jetzt die Abschnitts‑, Bild- und Tabellennummern? Sie erfüllen nur noch den Zweck, den Inhalt in eine logische Reihenfolge zu bringen. Halt, falsch: sie sollen das suggerieren, denn ob der Inhalt auch eine Reihenfolge erfüllt, die auch für den Leser zweckmäßig ist, ergibt sich aus dem situativen Kontext: Wenn ich das Getriebe erst abschrauben muss, um an die Förderschnecke zu kommen, ist es vollkommen richtig, den Abschnitt „Getriebe abschrauben“ vor den Abschnitt „Förderschnecke ausbauen“ zu setzen. Aber muss ich dann auch entsprechend nummerieren? Wenn ich das Getriebe doch bereits ausgebaut habe, kann ich den Abschnitt ebenso gut überspringen. Die Nummerierung löst dann eher Verwirrung aus als dass sie mir weiterhilft, denn ich hätte immer das Gefühl, etwas Wichtiges übersehen zu haben, da ich die vorgegebene Reihenfolge nicht eingehalten habe. Wir sind als Leser so konditioniert, dass wir uns an eine Nummerierung halten. Wer „1.2.2“ liest, erwartet, dass der Inhalt unter Abschnitt 1.2.3 darauf aufbaut – selbst wenn er das nicht tut. Im Umkehrschluss lese ich nicht zuerst 1.2.2, ohne 1.2.1 überflogen zu haben. Gutes redaktionelles Arbeiten bedeutet aber auch, den Leser nicht mit Informationen zu überfrachten, die er nicht benötigt. Wenn in 1.2.1 etwas steht, was ich als Anwender in 1.2.2 wissen muss, muss ich es in 1.2.2 auch lesen statt meine Zeit damit zu vertrödeln, mich durch den gesamten Abschnitt 1.2.1 zu wühlen. Wenn es nur dort steht, hat der Redakteur etwas falsch gemacht, denn die Information sollte dort sein, wo sie benötigt wird. Warum also verwendet man dann die Nummerierung, wenn sie keine aufeinander aufbauende Information vermitteln soll? Genügt dann nicht die Überschrift? Meine Erfahrung dazu ist überraschend: ich lasse die Nummern weg (siehe Abbildung oben) – und es ist den Benutzern noch nicht mal aufgefallen… Teilen mit:MastodonWhatsAppE‑MailBlueskyMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … dokumentation FormatierungTypografie
appseits Kritzeln auf Tafeln, Teil 7: Richtiges konstruieren mit Shapr3D 11.07.202013.03.2022 OK, das ist jetzt nix mehr für den Alltagsgebrauch eines Normalsterblichen. 😉 Teilen mit:MastodonWhatsAppE‑MailBlueskyMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More
dokumentation Strukturierung der Dokumentation 15.11.199923.05.2023 Grundsätzlich gibt es immer mehrere Möglichkeiten, Dokumente zu strukturieren, um möglichst effizient das angestrebte Ziel… Teilen mit:MastodonWhatsAppE‑MailBlueskyMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More
Warum schreien Sie hier so rum? 08.09.2006 Selbst simpelste Textverarbeitungsprogramme bieten dem Benutzer heutzutage schier unendliche Möglichkeiten, seinen Text zu formatieren. Sofern… Teilen mit:MastodonWhatsAppE‑MailBlueskyMehrDruckenLinkedInTelegramPinterestGefällt mir:Gefällt mir Wird geladen … Read More