Ich habe ein ganzes Buch zu diesem Thema geschrieben. Es heißt Every Page is Page One: Topic Based Writing for Technical Communication and the Web . Darin betrachte ich die Forschung darüber, wie Menschen technische Informationen verwenden und wie das Web die Art und Weise verändert, wie wir Informationen allgemein verwenden, und stelle sieben Prinzipien für die Themengestaltung vor.

Eines der Dinge, mit denen ich mich bei der Vorbereitung des Buches intensiv beschäftigt habe, war das Thema Länge. Meine Schlussfolgerung war, dass Länge kein sinnvoller Weg ist, um das Problem anzugehen. Stattdessen sollten wir an das denken, was in der Softwaretechnik als Kohäsion bezeichnet wird: das Ausmaß, in dem alle Teile eines Moduls zusammengehören.

Ein zusammenhängendes Thema löst ein Benutzerproblem. (Nicht unbedingt das ganze Problem, das sie mitgebracht haben, das sich aus mehreren Teilproblemen zusammensetzen kann, sondern ein eigenständiges Problem.) Die Anzahl der Informationen, die erforderlich sind, um ein zusammenhängendes Thema zu erstellen, das ein Problem behandelt, kann erheblich variieren. Daher ist die Länge kein nützliches Maß.

Meine sieben Prinzipien des Designs „Jede Seite ist Seite Eins“ sollen eine Anleitung zum Erstellen zusammenhängender Themen geben. Die Befolgung dieser Prinzipien sollte zu Themen führen, die die richtige Länge für ihre Arbeit haben. Die sieben Prinzipien sind:

1. Ein EPPO-Thema ist in sich abgeschlossen. Es hat kein notwendiges vorheriges oder nächstes Thema.

2. Ein EPPO-Thema hat einen bestimmten und begrenzten Zweck.

3. Ein EPPO-Thema entspricht einem Typ. Wenn Sie ein zusammenhängendes Themendesign erreicht haben, werden Sie feststellen, dass jedes Thema dieses Typs demselben Muster folgt, da in jedem Fall dieselben Informationsbedürfnisse auftreten. Sobald Sie das Muster erkennen, können Sie es verwenden, um das Schreiben zukünftiger Themen zu leiten.

4. Ein EPPO-Thema stellt den Kontext her. Da es das erste Thema ist, das ein Leser möglicherweise liest, muss ein Thema seinen Kontext festlegen, damit der Leser weiß, wo er sich befindet und welche Art von Informationen ihn erwartet.

5. Ein EPPO-Thema setzt voraus, dass der Leser qualifiziert ist. Dies mag kontraintuitiv erscheinen, aber wenn Sie beim Leser nicht ein gewisses vernünftiges Maß an Kompetenz voraussetzen, werden Sie am Ende versuchen, alles zu erklären, und Ihr Thema wird zu einem Buch. Sie unterstützen unqualifizierte Leser, indem Sie sie auf andere Themen verweisen.

6. Ein EPPO-Thema bleibt auf einer Ebene. Unterschiedliche Leser suchen zu unterschiedlichen Zeitpunkten auf ihrem Weg zum Verständnis nach unterschiedlichen Informationsebenen. Lassen Sie die Leser entscheiden, wann sie die Ebene wechseln möchten, indem sie die Themen wechseln. Sonst werden Sie den anderen Grundsätzen nicht folgen können und Ihren Themen fehlt der Zusammenhalt.

7. EPPO-Themen sind reich verknüpft. Jedes Thema ist in einen viel größeren Themenraum eingebettet. Um Ihr Thema zusammenhängend und auf ein Problem fokussiert zu halten, dürfen Sie nicht ständig verwandte Themen einbringen. Aber die Leser brauchen immer noch einen einfachen Zugang zu diesen verwandten Themen. Links bieten diesen Zugang. In der Softwareentwicklung ist die Kehrseite der Kohäsion die lose Kopplung. Links sorgen für die lose Kopplung, die den Zusammenhalt von Themen ermöglicht.

Fazit: Länge ist das falsche Maß. Konzentrieren Sie sich darauf, Ihre Themen zusammenhängend zu gestalten und sie sinnvoll miteinander zu verknüpfen. Dadurch entstehen Themen unterschiedlicher Länge, aber jedes hat die richtige Länge für die Aufgabe, die es zu erledigen hat.

TL;DR

Kurze Seiten sind besser.

Die ideale Struktur

Ich würde folgendes empfehlen:

• Jede Seite sollte einen einzigen, klar definierten Zweck haben
• Jede Seite sollte eine klar definierte Zielgruppe haben
• Seiten sollten mit anderen, relevanten Seiten verlinkt sein
• Strukturieren Sie Ihre Seiten wie einen Baum, mit Übersichtsseiten näher an der Wurzel, die mehr Details bieten, wenn Sie sich zu den Blättern bewegen
• Stellen Sie mehrere Inhaltsseiten bereit, die die Rollen und Interessen der Leser widerspiegeln
• Stellen Sie eine umfassende Suchfunktion bereit
• Ermutigen Sie Seitenbenutzer, zu den Inhalten beizutragen

Meiner Erfahrung nach ist ein Wiki ein ideales Vehikel, um diese Funktionen bereitzustellen.

Rechtfertigung

• Die meisten Menschen finden lange Seiten entmutigend
• Es ist einfacher, Informationen auf einer kurzen Seite zu finden
• Inhaltsseiten helfen, den Aufbau der Dokumentation zu verdeutlichen
• Überblick und Vertiefung sind getrennt und werden wahrscheinlich von verschiedenen Lesern (oder Lesern mit unterschiedlichem Wissensstand) konsumiert.
• Programmierer sind mit dieser Struktur vertraut
• Inhaltsbäume und Suche machen diese Struktur sehr navigierbar
• Niemand hat etwas dagegen zu klicken, besonders Programmierer. Die alte Zwei-Klick-Regel gilt einfach nicht mehr.
• Eine gute globale Suche macht die In-Page-Suche weniger wichtig
• Dokumente, die in Zusammenarbeit mit ihren Lesern erstellt wurden, sind im Allgemeinen besser als die von einem einzelnen Autor erstellten

Über mich

Ich bin ein Programmierer mit über 20 Jahren Erfahrung in der Branche. Das Team, zu dem ich gehöre, erstellt einige der besten Dokumentationen, die ich je gesehen habe. Wir tun dies mit einem MediaWiki-basierten Wiki für unsere gesamte Dokumentation. Jeder im Team leistet Beiträge, bearbeitet, klärt, korrigiert usw. Noch wichtiger ist, dass wir alle die Dokumentation lesen , weil wir sie gemeinsam entwickelt haben, um die Bedürfnisse zu erfüllen, die wir tatsächlich haben, und nicht die Bedürfnisse anderer Dinge, die wir haben könnten.