Den echten Sammler erkennt man nicht an dem, was er hat, sondern an dem, worüber er sich freuen würde. (Marc Chagall)

Diesem Zitat folgend können wir sagen: „Wir sind echte Sammler!“. Denn wir freuen uns immer riesig, wenn uns gute Beispiele von Hilfesystemen in der Softwaredokumentation begegnen. Wir sammeln gute Umsetzungen von moderner Softwaredokumentation, lassen uns inspirieren und suchen häufiger auch das Gespräch mit den Schöpfer:innen dieser Werke, um ein Lob dazulassen.

Ein paar dieser Beispiele wollte ich heute mit dir teilen, damit auch du ein paar Beispiele zur Hand hast, wie eine gute Softwaredokumentation aufgebaut sein kann. Lass dich davon inspirieren, wie andere ihre Online-Hilfe strukturieren und welche Elemente die Teams für bessere User-Experience im Umgang mit ihren Anleitungen einsetzen. Heute nun vier Beispiele für gute Hilfesysteme in der Softwaredokumentation:

Beispiel Nr. 1 | Notion

Notion ist eine Webanwendung für Produktivität und Notizen. Stark verbreitet und beliebt bei Menschen, die z.B. große Mengen an digitalem Content produzieren. Die Anwendung von Notion ist übersichtlich und intuitiv. Um die vollen Potenziale zu entfalten, benötigt es dann allerdings doch ein wenig „Hilfe“.

Hier gehts zur Online-Hilfe von Notion

Was mir gut gefällt:

• Notion gliedert die Online-Hilfe nach den Bereichen Referenz, Lernen und API. Das bietet jedem einzelnen die Möglichkeit, den besten „fit“ für sein Knowhow-Level zu finden.
• Die wichtigsten Artikel pro Kategorie, werden auf der Startseite bereits dargestellt. Für den Bedarfsfall wird allerdings deutlich hervorgehoben, dass noch „7 mehr“ in dieser Kategorie enthalten sind.
• Der Fokus der Artikel liegt auf Videoanleitungen, die sehr präsent für den audiovisuellen Lerntyp direkt als erstes angezeigt werden.
• Textform bleibt erhalten. Übersichtlich gegliedert und mit einem Inhaltsverzeichnis für den Topic.
• Wo notwendig und schwer zu erklären, werden im Topic GIF-Animationen zur Referenzbildung eingesetzt.

Was mir nicht gefällt:

• Die standardisierte Auszeichnung der Textelemente ist zu flach. Dadurch wirken lange Passagen etwas zu voll. Hier könnte mehr mit visuellen Stilmitteln gearbeitet werden.
• Der Schreibstil ist gesprächshaft, allerdings sehr inkonsistent und häufig auch zu lang. Abtönungspartikel und Stoppwörter, blähen die Texte unnötig auf.
• Auszeichnungselemente werden häufig inkonsistent eingesetzt. So wird z.B. ein Button auf die gleiche Art ausgezeichnet, wie die Benennung eines Dateiformates.

Beispiel Nr. 2 | Ditto

Bei ditto handelt es sich um ein Plugin für das UI-/UX-Design-Tool Figma, welches es UX-Writer:innen ermöglicht, die Microcopy für die erstellten Produktprototypen direkt in Figma selbst zu verwalten. So wird die Kollaboration mit UX- und UI-Designer:innen als auch anderen UX-Writer:innen gefördert und zudem in einer frühen Phase schon auf „echte“ Texte in der Produktentwicklung gesetzt. Ditto kann viel und das muss häufig erklärt werden.

Hier gehts zur Online-Hilfe von ditto

Was mir gut gefällt:

• Ditto gliedert die Online-Hilfe nach sachlogischen Zusammenhängen und baut das didaktische Konzept vom einfachen zum komplexen auf.
• Das Layout von ditto ist übersichtlich und bietet eine relativ präsente Suchfunktion.
• Wo notwendig und schwer zu erklären, werden im Topic GIF-Animationen zur Referenzbildung eingesetzt.
• Stellenweise setzt ditto auf einen Advance Organizer und auch eine Zielgruppeninformation pro Topic (bei Bedarf). Das schafft Übersicht.

Was mir nicht gefällt:

• Trotz teilweise langer Topics mit mehreren Zwischenüberschriften (Handlungen), fehlt mir in ditto das Inhaltsverzeichnis für den Topic selbst.
• GIF-Animationen und Bilder können leider nicht vergrößert werden. Hier leidet die Erkennbarkeit der Inhalte auf dem Bild bzw. GIF, wenn große Bildausschnitte gewählt werden.

Beispiel Nr. 3 | Miro

Bei Miro handelt es sich um ein digitales „Whiteboard“, welches zur Kollaboration im Team eingesetzt werden kann. Ein riesengroßer Arbeitstisch, auf welchem ihr eure Workshops, Brainstormings, Meetings oder auch einfach nur Ideen festhalten, teilen oder exportieren könnt.

Hier gehts zur Online-Hilfe von Miro

Was mir gut gefällt:

• Miro bietet eine sehr präsente Suchleiste für den schnellen Einstieg und ein wirklich übersichtliches Dashboard, welches Trendthemen, häufige Fragen und auch curricular oder sachlogisch gruppierte Topics für zahlreiche Zielgruppen bereitstellt. Das sorgt dafür, dass einzelne Personen sich schnell selbst zuordnen und den passenden „Bereich“ finden können.
• Jedes Topic verfügt neben der Hauptnavigation des Bereichs auf der linken Seite auch über eine sekundäre Navigation für den jeweiligen Topic und seine Zwischenüberschriften. Die Navigation wird hierdurch stark erleichtert.
• Die Suche bleibt präsent, auch wenn man sich in die Topic-Struktur hinab bewegt.
• Miro setzt Rahmen für ihre Screenshots ein, die den gewählten Bildausschnitt widerspiegeln. Wird ein Screenshot vom oberen, linken Bildschirmrand erstellt, so wird der Rahmen auch nur oben und rechts angezeigt. Ein kleines Element, das der Orientierung hilft.
• Ein Breadcrumb-Menü ermöglicht jederzeit das Zurückkehren zu den vorherigen Ebenen der Online-Hilfe.

Was mir nicht gefällt:

• Die Autor:innen der Miro-Hilfe arbeiten nur wenig mit Auszeichnungselementen auf der Inhaltsebene.
• Handlungen werden als Fließtexte beschrieben, was die Scannbarkeit der einzelnen Handlungsschritte für die lesende und ausführende Person erschwert.
• UI-Elemente werden in Ihrer Auszeichnung nicht unterschieden und sind daher nicht leicht als solche zu erkennen.

Beispiel Nr. 4 | Microsoft

Microsoft ist eine ganze Welt an digitalen Lösungen und Geräten für nahezu alle Lebensbereiche im IT-Sektor. Dementsprechend groß, ist auch die Support-Landschaft von Microsoft. Hier gibt es Hilfe zu nahezu allen Produkten, die das Unternehmen bietet, von Microsoft 365 als Tool-Paket, einzelne Lösungen wie Outlook oder OneDrive, bis hin zu Betriebssystemen wie Windows 11, Spielen und sogar Surface-Geräten.

Hier gehts zur Online-Hilfe von Microsoft

Was mir gut gefällt:

• Es sind mehrere „Facettenfilter“ vorhanden, die nach Gerät, Softwareprodukt, Themenspektrum o.Ä. eingrenzen lassen.
• Innerhalb des Topics für einzelne Produktfunktionen setzt Microsoft in der Hilfe „Reiter“ ein, um einen Hilfe-Artikel auf den Gerätetyp anzupassen, auf welchem ich das Produkt betreibe (z.B. macOS oder Windows).
• Innerhalb des Topics setzt auch Microsoft stark präsent auf Videoanleitungen.
• Handlungen, sind gut ausgezeichnet, sodass diese direkt als solche erkennbar sind.
• Einzelne Handlungsschritte werden in Listenpunkten dargestellt und UI-Elemente wie z. B.: Buttons, Textfelder oder Menüfolgen werden unterschiedlich ausgezeichnet. Das schafft Übersicht.

Was mir nicht gefällt:

• Microsoft setzt auf recht kurze Topics, was sehr gut ist, dennoch werden diese oftmals lang und benötigen Zwischenüberschriften. Eine Nebennavigation pro Topic, hat mir persönlich gefehlt.
• In Teilbereichen der Hilfen, setzt Microsoft in den lokalisierten, deutschen Videos auf Text-to-Speech. Auch wenn dies bereits recht passabel funktioniert, braucht es noch zu oft mehrere Anläufe, bis man verstanden hat, was denn im Detail gesagt wurde.
• Die Menge diverser Inhalte im Microsoft Support-Center erzeugen eine hohe kognitive Belastung, zusätzlich dazu baut Microsoft Werbungen für andere Produkte aus dem eigenen Hause in das Support-Portal ein. Das macht neugierig, lenkt ab und hat m. E. nach in einem Support-Portal nur wenig verloren.

Fazit

Jede der genannten Online-Hilfen ist wirklich gut gelöst. Während die einen kreative, gesprächshafte Ansätz wählen, verlassen sich vor allem die großen Player auf standardisierte Strukturen, die möglichst wenig kognitive Belastung im Umgang mit den Informationsfluten erzeugen und eine schnelle, scannbare Auffindbarkeit und Erfassbarkeit der gesuchten Lösung ermöglichen. Zusammenfassend halte ich folgende Elemente für essenziell im Kontext guter und moderner Softwaredokumentation:

• Die Suche als zentrales Kernelement der Hilfe mit excellenter Suchalgorithmik im Hintergrund.
• Die Technik ausreizen mit Facettenfiltern, durchdachten didaktischen Konzepten und klarer Informationsarchitektur.
• Auszeichnung von Inhalten mittels Funktionsdesign® o.ä. sodass Handlungen, Handlungsschritte, UI-Elemente ohne Verzögerung wiedererkannt werden können.
• Diverse Navigationsmöglichkeiten für besseres „Browsing“ in den Inhalten. Neben einer Hauptnavigation benötigt es eine Nebennavigation für lange Topics, den Verweis zu didaktisch logischen „Verwandten Themen“, Breadcrumbs für das „zurücknavigieren“ (vor allem dann, wenn der Einstieg direkt in der Unterseite erfolgt und nicht über den Browser angelaufen worden ist).
• Audiovisuelle Inhalte und standardisierte Grafik-Elemente für bessere Referenzbildung zwischen Text und Produktkontext.
• GIFs statt Screenshots – das spart Platz und ist deutlich besser erfassbar.
• …

Wie siehst du das? Welche Elemente sind in einer modernen Softwaredokumentation deiner Ansicht nach unverzichtbar und warum? Kennst du weitere Hilfen, die du uns ans Herz legen möchtest? Dann besuche uns gern auf LinkedIn und lass uns quatschen! Wir freuen uns auf den Austausch!

Du willst deine Softwaredokumentation auf Vordermann bringen und weißt nicht so recht, wie? Dann ist unser Seminar „Grundlagen guter Softwaredokumentation“ genau das richtige für dich! Meld dich an und lerne alles, was du für den Kickstart moderner Softwaredokumentation in deinem Unternehmen brauchst!