Nicht alle Dokumentationen erfüllen denselben Zweck. Ein Schritt-für-Schritt-Leitfaden, der jemanden durch einen Prozess führt, erfüllt eine völlig andere Aufgabe als ein Referenzartikel, der eine Liste von Parametern definiert. Die Verwendung des falschen Inhaltstyps für eine Aufgabe ist einer der häufigsten Gründe, warum Dokumentation die Leser im Stich lässt – selbst wenn die Informationen selbst korrekt sind.
Dieser Artikel beschreibt fünf Kerninhaltstypen, die in einer gut strukturierten Wissensdatenbank verwendet werden, erklärt die Aufgaben jedes einzelnen und hilft Ihnen zu erkennen, welcher Typ für einen bestimmten Bedarf am besten geeignet ist. Die ersten vier basieren auf dem weit verbreiteten Diátaxis-Rahmen (Tutorials, Anleitungen, Referenzen und Erklärungen); Fehlerbehebung wird hier als Fünfte hinzugefügt, da sich diagnostische Inhalte so unterschiedlich verhalten als beide, dass sie eine eigene Definition verdienen.
Die fünf Kerninhaltstypen
Anleitungen
Eine Anleitung führt den Leser von Anfang bis Ende durch eine bestimmte Aufgabe. Es setzt voraus, dass der Leser ein Ziel hat und weiß, warum er es erreichen will – er muss nur wissen, wie. Der gesamte Artikel ist um Handlungsschritte gegliedert, die ein konkretes Ergebnis erzielen.
| Die Arbeit, die sie erfüllt | Ermöglicht es dem Leser, eine reale Aufgabe zu erledigen. |
| Wann man es einsetzen sollte | Wann immer ein Leser etwas Bestimmtes tun muss – eine Funktion einrichten, eine Einstellung konfigurieren, einen Workflow abschließen. |
| Was es nicht ist | Ein Tutorial (das lehrt), eine Referenz (die informiert) oder ein konzeptioneller Artikel (der erklärt). Ein Anleitungsleitfaden lehrt keine Konzepte; Sie führt den Leser durch die Schritte. |
| Erkennbar durch | Ein aufgabenorientierter Titel ("Wie man die Zwei-Faktor-Authentifizierung einrichtet"), nummerierte Schritte, ein definierter Startpunkt und ein definiertes Ergebnis. |
Tutorials
Ein Tutorial bringt einem Leser bei, wie man etwas macht, indem er es selbst tun lässt. Das Ziel ist Lernen, nicht die Erledigung von Aufgaben. Ein Leser folgt einem Tutorial, um Verständnis und Können aufzubauen, nicht weil er ein unmittelbares reales Bedürfnis hat. Das Tutorial steuert die Umgebung – es kann Beispieldaten, eine Sandbox oder ein vereinfachtes Szenario verwenden, das speziell für das Lernen entwickelt wurde.
Scoping-Hinweis: In der Praxis ist diese Kategorie leicht zu überbeanspruchen. Wenn Ihre Wissensdatenbank tatsächlich keinen Sandbox, keinen Beispieldatensatz oder keinen speziellen Onboarding-Weg bietet, sind die meisten Inhalte, die als "Tutorial" bezeichnet werden, eigentlich eine getarnete Anleitung – der Leser hat eine echte Aufgabe vor Augen, kein abstraktes Lernziel. Reserviere "Tutorial" für Inhalte, die wirklich in einer kontrollierten Umgebung unterrichten; Ansonsten schreiben Sie stattdessen eine Anleitung.
| Die Arbeit, die sie erfüllt | Das baut Kompetenz und Selbstvertrauen bei einem neuen Nutzer auf. |
| Wann man es einsetzen sollte | Beim Einarbeiten neuer Nutzer, der Einführung einer komplexen Funktion oder der Unterstützung der Leserinnen und Leser bei der Entwicklung von Fähigkeiten, die sie noch nicht haben – wirklich durch eine kontrollierte, lernorientierte Umgebung. |
| Was es nicht ist | Ein How-to-Guide (der eine echte Aufgabe löst) oder ein konzeptueller Artikel (der erklärt, ohne zu tun). Ein Tutorial beinhaltet immer Handlung – der Leser muss etwas tun. |
| Erkennbar durch | Eine lernorientierte Rahmung ("In diesem Tutorial lernst du, wie man..."), eine kontrollierte oder Beispielumgebung, und eine explizite Aussage, was der Leser am Ende tun kann. |
Konzeptuelle Artikel
Ein konzeptioneller Artikel erklärt, wie etwas funktioniert, was etwas ist oder warum etwas so gestaltet ist, wie es ist. Es gibt keine Anweisungen – es informiert. Der Leser geht mit Verständnis nach Hause, nicht mit einer abgeschlossenen Aufgabe.
| Die Arbeit, die sie erfüllt | Es baut das mentale Modell auf, das ein Leser braucht, um ein Produkt effektiv zu nutzen. |
| Wann man es einsetzen sollte | Wenn man ein neues Konzept einführt, die Architektur eines Systems erklärt oder einem Leser hilft, die Beweggründe hinter einer Designentscheidung zu verstehen, bevor er damit interagiert. |
| Was es nicht ist | Eine Anleitung oder ein Tutorial. Ein konzeptioneller Artikel hat nie nummerierte Schritte. Es erklärt: es gibt keine Anweisungen an. |
| Erkennbar durch | Ein konzeptorientierter Titel ("Verständnis der rollenbasierten Zugriffskontrolle"), prosalastige Inhalte, Diagramme und Beispiele sowie das Fehlen von prozeduralen Schritten. |
Referenzartikel
Ein Nachschlagewerk liefert präzise, strukturierte Informationen, die die Leser nachschlagen, nicht in der Reihenfolge lesen. Es ist eine Ressource, die mitten in einer Aufgabe konsultiert wird und nicht von Anfang bis Ende gelesen wird. Nachschlagewerke stellen Vollständigkeit und Präzision über den erzählerischen Fluss.
| Die Arbeit, die sie erfüllt | Bietet den Lesern schnellen Zugang zu genauen, vollständigen technischen Informationen. |
| Wann man es einsetzen sollte | API-Dokumentation, Parameterlisten, Tastenkombinationen, Fehlercode-Definitionen, Glossare, Konfigurationsoptionen – überall dort, wo ein Leser etwas nachschlagen muss. |
| Was es nicht ist | Ein Tutorial oder eine Anleitung. Referenzartikel führen die Leser nicht durch einen Prozess. Sie liefern Informationen; Der Leser entscheidet, was er damit macht. |
| Erkennbar durch | Ein strukturiertes, vorhersehbares Format (Tabellen, Definitionslisten, Codeblöcke), ein konsistentes Muster über Einträge hinweg und ein Titel, der das Nachschlagverhalten signalisiert ("API-Referenz", "Tastenkürzel"). |
Fehlerbehebungsartikel
Ein Artikel zur Fehlerbehebung hilft dem Leser, ein Problem zu diagnostizieren und zu lösen. Sie ist nach Symptomen und deren Lösungen organisiert, nicht nach Produktmerkmalen. Ein Leser kommt, weil etwas nicht stimmt – die Aufgabe des Artikels ist es, ihm zu helfen, zu erkennen, was es ist, und es zu beheben.
Im Gegensatz zu einer Anleitung, die mit einem Ziel beginnt ("Ich will X erreichen"), beginnt ein Fehlerbehebungsartikel mit einem Symptom ("X funktioniert nicht"). Diese Unterscheidung – Ziel zuerst versus Symptom zuerst – ist der Grund, warum das Troubleshooting von Inhalten hier eine eigene Kategorie bekommt, anstatt in Anleitungen einzufügen.
| Die Arbeit, die sie erfüllt | Löst ein Problem, das der Leser aktiv erlebt. |
| Wann man es einsetzen sollte | Fehlermeldungen, unerwartetes Verhalten, fehlgeschlagene Prozesse, häufige Supportprobleme. |
| Was es nicht ist | Eine Anleitung (die davon ausgeht, dass alles funktioniert) oder ein Nachschlagewerk (der Informationen liefert, ohne ein bestimmtes Problem zu lösen). Ein Fehlerbehebungsartikel ist diagnostisch – er beginnt mit einem Symptom, nicht mit einem Ziel. |
| Erkennbar durch | Symptom-zuerst-Organisation ("Wenn du siehst... / Wenn du es nicht kannst..."), bedingte Logik, mehrere mögliche Ursachen für ein einzelnes Symptom und Eskalationspfade, wenn die Lösungen des Artikels das Problem nicht lösen. |
Inhalte, die nicht ordentlich passen
Diese fünf Typen decken den Großteil einer Wissensbasis ab, aber nicht alles. Inhalte wie FAQs, Glossare, Release Notes und Produktübersichten oder Landingpages entlehnen oft von mehreren Typen, ohne vollständig zu übereinstimmen – ein FAQ zum Beispiel verhält sich wie ein Referenzartikel (nachgeschlagen, nicht von Anfang bis Ende gelesen), ist aber um Fragen und nicht um ein strukturiertes Schema organisiert. Behandle diese als eigene anerkannte Ausnahmen, anstatt sie in eine der fünf Kategorien zu zwingen; Wichtig ist, dass jeder Inhalt eine klare, einheitliche Aufgabe hat, wie auch immer man sie nennt.
Mischen von Inhaltstypen
In der Praxis kann ein einzelner Artikel auf mehr als einen Inhaltstyp zurückgreifen. Eine Anleitung könnte einen kurzen konzeptionellen Absatz enthalten, der erklärt, warum ein Schritt wichtig ist. Ein Fehlerbehebungsartikel könnte eine Referenztabelle mit Fehlercodes enthalten.
Das ist in Ordnung, solange der Hauptzweck des Artikels klar bleibt. Leser müssen sofort erkennen können, welche Art von Artikel sie lesen und was sie daraus ziehen werden. Ein Artikel, der gleichzeitig lehren, anleiten, erklären und Probleme beheben will, wird keines dieser Dinge gut machen.
Wenn ein Artikel zu viele Zwecke erfüllt, teilt ihn auf.
Die Wahl des richtigen Inhaltstyps
Wenn Sie sich hinsetzen, um einen neuen Artikel zu schreiben, stellen Sie zuerst eine Frage: Was muss mein Leser mitnehmen?
| Der Leser muss mit ... | Schreib ein... |
|---|---|
| Eine erfüllte Aufgabe | Anleitung |
| Eine neue Fähigkeit oder ein neues Verständnis, erworben durch das Handeln | Tutorial |
| Ein mentales Modell oder eine Erklärung | Konzeptaufsatz |
| Eine bestimmte Information | Referenzartikel |
| Ein gelöstes Problem | Fehlerbehebungsartikel |
Das richtig zu machen, bevor du mit dem Schreiben anfängst, sparst später erhebliche Überarbeitungszeit. Ein gut gewählter Inhaltstyp gibt dem Artikel seine Form; Ein schlecht gewählter Kandidat bedeutet, von Grund auf neu zu schreiben.