Das beste Softwareprodukt hast du dann, wenn du keine Softwaredokumentation brauchst, höre ich oft aus der Riege der Softwareentwickler:innen und UX-Expert:innen. Doch vor allem bei komplexen Softwareprodukten, also denen, welche von Experten und Expertinnen bei ihrer täglichen Arbeit eingesetzt werden, spielt in der Welt der Softwareentwicklung die Softwaredokumentation eine entscheidende Rolle. Sie ermöglicht nicht nur Benutzern und Benutzerinnen, sondern auch Entwicklern und Entwicklerinnen, das Produkt effektiv zu nutzen und zu verstehen. Ist die Softwaredokumentation gut strukturiert, erleichtert diese das Auffinden der benötigten Informationen und verbessert damit die Usability.

Doch wie lässt sich eine Softwaredoku strukturieren, um effektive und leicht verständliche Anleitungen zu kreieren? Anbei habe ich dir ein paar Best-Practices für deine Struktur in der Softwaredokumentation zusammengepackt:

 

Beginne mit einer klaren Gliederung

Eine durchdachte Gliederung stellt den Schlüssel zu einer effektiven Softwaredokumentation dar. Sie ermöglicht dir, die benötigten Informationen schnell und einfach zu finden. Meine Tipps für deine Gliederung:

  • Verwende eine hierarchische Struktur: Setze auf Haupt- und Unterabschnitte, um eine nachvollziehbare Struktur zu schaffen.
  • Fasse zusammengehörige Inhalte zusammen, um die Navigation und das Verständnis zu verbessern.
  • Verwende Überschriften, die aussagekräftig sind und präzise ausdrücken, welchen Inhalt deine Benutzer:innen in dem folgenden Abschnitt erwarten können.

 

Schaffe ein konsistentes Erlebnis in deiner Dokumentationslandschaft

Softwaredokumentation besteht meist aus mehr, als einem einzelnen Informationsprodukt. Vielmehr ist es eine Dokumentationslandschaft, bestehend aus mehreren Informationsprodukten. Ein konsistentes Format und standardisierte Elemente ermöglichen hierbei deinen Benutzer:innen sich schneller zurechtzufinden und die benötigten Informationen leichter zu finden. Darauf solltest du achten:

  • Typografie und Layout
  • Standardisierte Auszeichnung von Inhaltselementen (Hinweise, Handlungsschritte, Ergebnisse, Tipps, Gerätereaktionen und Co.)
  • Einheitliche Gliederungsstruktur und Inhaltsverzeichnis.
  • Standardisierte Grafiken und Bilder.

 

First things first: Packe die wichtigen Informationen nach vorne

Die Informationen, die für deine Zielgruppen die größte Relevanz haben, solltest du so platzieren, dass diese leicht zugänglich und möglichst weit oben in deiner Informationsarchitektur platziert sind. So gehört oftmals der „Überblick über die Benutzungsoberfläche“ noch vor die eigentlichen Handlungsanleitungen zu bestimmten Themen.

 

Baue deine Informationsarchitektur curricular auf

Häufig auch unter dem Begriff „Progressive Information Disclosure“ bekannt, beschreibt dieser Ansatz die schrittweise Bereitstellung von Informationen in einer lernlogischen Reihenfolge. Dies hat den Vorteil, dass Informationen in „Häppchen“ dargeboten werden und den Benutzer:innen so einen besseren Fokus ermöglichen. Hierbei kannst du mehrere Ansätze verfolgen:

  • Gliederung vom Einfachen zum Zusammengesetzten
  • Gliederung vom Allgemeinen zum Speziellen

 

… hier nur mal zwei wichtige didaktische Konzepte genannt. Aber auch folgendes unterstützt dich hierbei:

  • Blende „spezielle“ oder „detailreiche“ Informationen aus und setze auf Verweise und Hyperlinks für weiterführende Informationen.
  • Details lassen sich auch häufig hinter Tabs oder sogenannten „Akkordeon-Elementen“ verstecken, die sich Benutzer:innen bei Bedarf aufklappen können.

 

Nutze die Vielfalt der Navigationsmöglichkeiten in HTML-Hilfen

Vor allem bei Softwaredokumentationen, die via HTML-Hilfe ausgeliefert werden, gibt die Technik heute eine Vielzahl an Navigationsmöglichkeiten her, die du allesamt für die bessere Auffindbarkeit und Zugänglichkeit deiner Informationen nutzen kannst. Speziell für die Navigation eignen sich hierbei:

  • Hauptnavigation zur Orientierung in der Hilfe,
  • Nebennavigation zur Orientierung im aufgerufenen Artikel,
  • Breadcrumb-Menüs zur besseren Nachvollziehbarkeit des Pfades.
  • Querverweise und Hyperlinks für verwandte Themen und Co.
  • Diverse Unterschriftenebenen, die eine visuelle Hierarchie abbilden.

 

Wähle weise, welche Struktur du für deine Softwaredokumentation heranziehst

Generell gibt es unterschiedliche didaktische Methoden und Strukturierungsmöglichkeiten in der Softwaredokumentation. Dabei hängt die Wahl deiner Struktur stark von deinen Stilgruppen als auch deren Informationsbedarf ab, welche der Strukturen sich für deine Produktdokumentation am Besten eignet. Einige Wichtige, möchte ich dir hier vorstellen:

  • Lineare Struktur:
    Hierbei wird die Software-Doku linear in einer Reihenfolge abgebildet. Gestartet wird hierbei häufig mit grundlegenden Informationen. Je tiefer du in die Struktur einsteigst, desto spezieller und fortgeschrittener werden die Themen. Eine lineare Struktur eignet sich besonders bei neuen Benutzer:innen für Tutorials oder Anleitungen.
  • Hierarchische Struktur:
    Bei dieser Strukturierungsart werden die Informationen in einer Baumstruktur organisiert. Bei dieser Struktur werden Hauptthemen in Unterthemen gesplittet, die wiederum weitere Unterteilungen besitzen können. Eine Baumstruktur eignet sich besonders gut für umfangreiche und z.B. zielgruppenübergreifende Dokumentationslandschaften.
  • Modulare Struktur:
    Bei dieser Strukturierungsmethode werden Themen in abgeschlossenen „Modulen“ zusammengefasst und funktionieren dementsprechend isoliert. D.h. jedes Modul kann unabhängig von anderen Modulen gelesen und verstanden werden. Vor allem bei komplexen Produkten, mit vielen Zielgruppen, die nur „Teile“ des Produktes nutzen, kann diese Strukturierungsmethode sehr gut funktionieren.
  • Funktionsorientierte Struktur:
    In dieser Struktur werden Funktionsbereiche der Software oder Konzepte zusammengefasst und als separate Abschnitte „gesammelt“. Diese Methode eignet sich für Informationsprodukte, die sich auf bestimmte Aspekte oder Funktionen der Software konzentrieren. Sie funktioniert aber nur dann gut, wenn Benutzer:innen nicht alle Informationen in einer bestimmten Reihenfolge lesen müssen.
  • Taskorientierte Struktur:
    Dies ist die meiner Meinung nach beste Struktur für eine Softwaredokumentation. Sie konzentriert sich auf die User-Journey, also die Aufgaben die Benutzer mit der Software ausführen und organisiert die Informationen so, dass diese die real durchzuführende Tätigkeit im Kontext der richtigen Reihenfolge aufgreifen. Wenn es um die Steigerung der User-Experience im Umgang mit dem Produkt als auch der Hilfe selbst geht, führt m.E. kein Weg an dieser Strukturierungsform vorbei. Gleichzeitig stellt diese einige Mehraufwände bereit, da du dir als Hersteller sehr genau Gedanken über die Geschäftsprozesse, die in dem Produkt abgebildet sind, machen musst. Du brauchst User-Storys, Use-Cases und Co., um hier ein qualitativ hochwertiges „Abbild“ der tatsächlichen Aufgaben der Benutzer:innen abzubilden.

 

Bei der Auswahl der für dich geeigneten Methode zur Strukturierung deiner Softwaredokumentation kommt es also, wie sollte es auch anders sein, immer auf die Bedürfnisse deiner Stil- bzw. Zielgruppen, die Komplexität deines Produktes und das Medium an, in welchem deine Informationsprodukte bereitgestellt werden. Doch unterm Strich bleibt: Eine gut durchdachte, nutzungsorientierte, effektive und effiziente Softwaredokumentation birgt hohe Potenziale für eine noch bessere User-Experience! Setze diese Potenziale für deine Produkte ein! Und falls du noch Hilfestellung dabei brauchst, welche anderen Methoden es gibt, wie und womit du deine Informationsarchitektur aufbaust und wie du deine Softwaredokumentation strukturierst… dann ist unser Seminar: „Modularisierung und Informationsarchitektur in der Softwaredokumentation“ genau das richtige für dich!