Kontextsensitive Hilfen können Teil der Vermarktungsstrategie sein und z. B. durch Screencasts beworben werden
Du hast bereits eine Softwaredokumentationslandschaft, doch diese sieht gerade eher nach großer Dürre aus?
Wir bringen wieder Leben in deine Informationsprodukte!
Manche unserer Kund:innen stehen noch ganz am Anfang und bauen ihre Redaktion rund um digitale Produkte erst auf. Diese befinden sich dann in der Problemphase des Aufbaus von Dokumentationsprozessen. Da braucht es Lösungen in Form von Festlegungen von Prozessen und Findung von Tools wie eines Redaktionssystems bzw. Content-Management-Systems.
Andere Kund:innen haben bereits ein Redaktionssystem und festgelegte Prozesse – doch eines oder beides davon funktioniert nicht so reibungslos wie sie könnten. Da braucht es etwas mehr in der Lösung. Du willst mehr von der Softwaredokumentation?
Unsere Kund:innen wollen mehr von ihrer Softwaredokumentation:
Hast du den Flow? Wir gehen mit dir Schritt für Schritt in Richtung moderne, fließende Softwaredokumentation.
Deine Softwaredoku muss fließen!
Dafür braucht es viele kleine zubringende Flüsse, die deine Softwaredokumentation zu einem konstant fließenden Strom machen.
Prozesse und Rollen
Die Richtigen finden
Rund um die Softwaredokumentationserstellung gibt es viele Prozesse und Rollen – und das abteilungs- und teilweise sogar standortübergreifend. Hier die richtigen Schnittstellen und Positionen zu setzen, kann deine Redaktionsprozesse wirklich effektiv machen; oder eben genau das Gegenteil, wenn das System nicht stimmt.
Eine Optimierung der Softwaredokumentation bedeutet oft eine Optimierung der Akteur:innen drumherum. Welche Informationen liegen im Unternehmen bereit, nur eben leider „versteckt“ in einer anderen Abteilung? Welche Kompetenzen haben die verschiedenen Rollen entlang des Erstellungsprozesses der Dokumentation und welche eben nicht?
Gemeinsam betrachten wir die wichtigsten Schnittstellen und bringen die Zahnräder wieder perfekt ineinander.
Diese Schnittstellen können je nach den spezifischen Anforderungen und der Organisation des Softwareunternehmens variieren. Wie sieht es bei dir aus?
Kenne deine Schnittstellen! Denn dann weißt du auch, wo du alle benötigten Informationen herbekommst. Besonders die regelmäßige Kommunikation mit dem Support oder direkt mit deinen Nutzer:innen kann deine Dokumentation noch besser machen!
Tools
Deine stillen Helferchen
Du hast bereits ein Redaktionssystem? Super, dann hast du bereits die Basis für herausragende Softwaredokumentation gelegt.
Hast du noch kein XML-basiertes Erstellungstool? Dann schau doch mal hier, dort zeigen wir dir, was ein CMS für dich an Wundern bewirken kann.
Bei der Erstellung einer Softwaredokumentation gibt es hilfreiche Tools z. B.:
- Content-Management-System (CMS)
- Dokumenten-Management-System (DMS)
- Bildbearbeitungssoftware / Videobearbeitungssoftware
- Bildschirmaufnahmesoftware / Screencast-Software
- Versionskontrollsysteme (VCS)
- Online-Hilfe-Systeme (z. B. MadCap Flare, Help+Manual, RoboHelp etc.)
- Übersetzungs-Management-Software / Terminologie-Management-Software
Natürlich ist es ganz individuell, welche Software du brauchst. Das Wichtigste ist, dann deine verschiedenen Softwarelösungen möglichst smart miteinander zu vernetzen. Denn das ist das nächste Level, also genau das, wo du hinwillst:
Eine smarte Informationslandschaft, in der Daten automatisch ein- und ausgespielt werden ohne dein Zutun.
Um Daten automatisch einzuspielen und auszuspielen, können verschiedene Ansätze eingesetzt werden. Hier sind einige Möglichkeiten:
CMS-Plattformen ermöglichen die Automatisierung der Veröffentlichung von Daten in der Dokumentation. Sie können Datenquellen, wie Datenbanken oder andere Systeme, anbinden und automatisch Inhalte aus diesen Quellen in die Dokumentation integrieren. Gemeinsam machen wir dein CMS zum Genie!
Viele moderne Software-Plattformen bieten Schnittstellen (APIs) an, die es ermöglichen, Daten automatisch abzurufen und in der Dokumentation anzuzeigen. Durch die Integration der Schnittstellen in die Dokumentation können aktuelle Daten, wie beispielsweise Live-Daten aus einer Anwendung oder dynamische Informationen, automatisch aktualisiert werden. Lass uns also unbedingt deine Schnittstellen anschauen und optimieren!
Durch die Verwendung von Skripten oder Tools können Daten automatisch aus der Software extrahiert und in die Softwaredokumentation eingefügt werden. Beispielsweise kann ein Skript Datenbankabfragen ausführen, um Informationen über Datenstrukturen, Tabellen und Felder zu sammeln und in der Dokumentation darzustellen – und das ganz bequem automatisch!
Eine effektive Möglichkeit, Daten in die Dokumentation einzuspielen, besteht darin, den Quellcode der Software zu dokumentieren. Kommentare im Code können verwendet werden, um wichtige Informationen über Funktionen, Klassen, Methoden oder Variablen zu erfassen. Dokumentationsgeneratoren wie Javadoc für Java oder Sphinx für Python können dann diese Kommentare analysieren und automatisch eine API-Dokumentation generieren. Das eignet sich für eine einfache interne Softwaredokumentation.
In einigen Fällen können Mock-Daten verwendet werden, um Beispiele und Demonstrationen in der Dokumentation zu generieren. Diese Daten können entweder manuell erstellt oder mit automatisierten Tools erzeugt werden, um eine realistische Darstellung der Funktionalität zu liefern. Auch mit Beispieldaten lässt sich also Optimierungspotential finden.
Automatisierte Tests können verwendet werden, um Daten aus der Software zu extrahieren und in die Dokumentation einzufügen. Zum Beispiel können Integrationstests oder Funktionstests die Software ausführen, um relevante Informationen wie Eingabe- und Ausgabedaten zu erfassen, die in der Dokumentation verwendet werden können. Wir ermitteln, welche Testdaten für deine Softwaredokumentation relevant sein können.
Diese Ansätze sind abhängig von der Art der Software, den verfügbaren Ressourcen und den Anforderungen an die Dokumentation. Wichtig ist: Lass es uns automatisch machen! Das spart Arbeit, Zeit und dadurch Geld!
Vielen Redaktionsabteilungen fehlt dazu das interne Know-how – und auch schlichtweg die Zeit, sich dieses anzueignen. Wir haben die Best Practices, um deine Redaktion mit ihren Tools smart zu machen! Was wir noch haben: Wir haben für dich einen Whitepaper mit allen Infos für den Weg zur modernen Softwaredokumentation bereitgestellt, den du hier runterladen kannst.
Kontextsensitivität
Genau da, wo deine Nutzer:innen es brauchen
Was bedeutet das überhaupt? Kontextsensitivität im Bereich der Softwaredokumentation bezieht sich auf die Fähigkeit der Dokumentation, relevante Informationen im Kontext der aktuellen Aktionen oder des aktuellen Arbeitsbereichs der Nutzer:innen bereitzustellen. Das bedeutet, dass die Dokumentation automatisch relevante Inhalte anzeigt, die in genau dem Moment für die Person relevant sind.
Es ist also der Grundsatz:
Genau die richtige Information in genau dem richtigen Moment!
Wenn die Dokumentation kontextsensitiv ist, kann sie den Nutzer:innen helfen, schnell auf die benötigten Informationen zuzugreifen, ohne dass sie nach ihnen suchen oder durch umfangreiche Dokumente blättern müssen. Die Dokumentation passt sich dynamisch an den aktuellen Kontext an und bietet spezifische Anleitungen, Beispiele oder Erklärungen basierend auf den Aktionen oder dem Arbeitsfluss der Anwender:innen.
UX-Writing
Die richtigen Worte finden
Wie steht es um deine Texte, also sowohl innerhalb deiner Software, also auch in deinen Anleitungen?
Viele unserer Kund:innen kamen genau deshalb zu uns: Schlechte Texte, die Nutzer:innen nicht verstehen – Frust bei den Nutzer:innen, dem Support, im Geldbeutel.
Es ist eigentlich so simpel: Texte müssen effektiv, klar und hilfreich für deine Nutzer:innen sein.
Denn diese Texte, auch Microcopy genannt, dienen dazu, den Anwender:innen Hilfestellung, Anweisungen oder Rückmeldungen zu geben. Es kann sich um Button-Texte, Fehlermeldungen, Platzhaltertexte, Tooltips oder andere kurze Texte handeln. Hier sind einige Aspekte, die Microcopy wirklich gut machen:
Klarheit und Prägnanz: Microcopy sollte klar und prägnant sein, um die Botschaft effektiv zu vermitteln; also kein Jargon oder komplexe Formulierungen.
Nutzungszentrierung: Microcopy sollte auf die Bedürfnisse und das Verständnis der Nutzer:innen ausgerichtet sein.
Konsistenz: Microcopy sollte konsistent in der gesamten Oberfläche sein. Das bedeutet, dass ähnliche Aktionen oder Situationen mit ähnlichem Text behandelt werden sollten.
Positivität: Microcopy kann durch eine positive und freundliche Sprache die Nutzungserfahrung verbessern. Statt Fehlermeldungen, die verunsichern, können freundliche Hinweise auf Probleme oder klare Anweisungen zur Problembehebung gegeben werden.
Kontextsensitivität: Microcopy sollte sich auf den spezifischen Kontext beziehen und relevante Informationen liefern. Beispielsweise kann ein Platzhaltertext in einem Eingabefeld eine klare Beschreibung dessen enthalten, was erwartet wird, oder ein Tooltip kann zusätzliche Erklärungen zu einem bestimmten Bedienelement bieten.
Visualisierung und Hervorhebung: Durch visuelle Elemente wie Farben, Icons oder Hervorhebungen kann Microcopy unterstützt werden. Diese visuellen Elemente können helfen, wichtige Informationen hervorzuheben oder Aktionen zu verdeutlichen.
Texte in Technischen Dokumentationen haben den Zweck, Nutzer:innen zu informieren, zu warnen und vor allem sie dann abzuholen, wenn sie ein Problem haben. Hier sind einige Aspekte, die Anleitungstexte wirklich gut machen:
Klarheit und Präzision: Gute Texte in einer Technischen Dokumentation sollten klar und präzise sein. Sie sollten Informationen in einer verständlichen und gut strukturierten Weise vermitteln.
Nutzungszentrierung: Gute Texte in einer Technischen Dokumentation sollten nutzungsfreundlich sein. Das bedeutet, dass sie leicht zu lesen, gut strukturiert und gut zugänglich sein sollten.
Zielgruppenorientierung: Gute Texte in einer Technischen Dokumentation berücksichtigen die Zielgruppe mit ihren Bedürfnissen, Vorkenntnissen und Emotionen.
Verständnis für den Arbeitskontext: Gute Texte in einer Technischen Dokumentation sollten den Arbeitskontext mit seinen Herausforderungen berücksichtigen.
Vollständigkeit: Gute Texte in einer Technischen Dokumentation sollten vollständig sein. Sie sollten alle relevanten Informationen enthalten, um Leser:innen bei der Nutzung der Software zu unterstützen.
Aktualität: Gute Texte in einer Technischen Dokumentation sollten auf dem neuesten Stand sein.
Die Kombination dieser Aspekte trägt dazu bei, dass deine Texte nutzungsfreundlich werden und helfen, effektiv mit der Software zu interagieren, Ziele zu erreichen und eine positive Erfahrung zu haben.
All diese textlichen Aspekte müssen standardisiert werden. Heißt, alle Autor:innen schreiben wie aus einer Feder. Die einzelnen, modularen Texte kannst du am besten in einem Redaktionssystem strukturieren und dann zu Informationseinheiten zusammenbauen. Mehr Infos dazu findest du hier.
Content-Delivery
Bereit durch Bereitstellung
Wie kommt dein herausragender Content jetzt zu deinen Softwarenutzer:innen?
Na, durch Content-Delivery-Portale!
Ein Content-Delivery-Portal ist eine Plattform, die es ermöglicht, deinen Inhalt dynamisch und in Echtzeit an verschiedene Ausgabekanäle zu liefern. Es ist eine weitere Komponente, die in deinem XML-basierten Redaktionssystem implementiert werden kann.
Hier sind drei Top-Vorteile, die ein Content-Delivery-Portal dir bieten kann. Mehr Infos findest du übrigens auf der eigenen Seite dazu hier.
Personalisierte Inhalte:
Mit einem Content-Delivery-Portal kannst du Inhalte basierend auf den spezifischen Anforderungen und Präferenzen deiner Nutzer:innen personalisieren. Du kannst beispielsweise Inhalte basierend auf der Rolle, den Interessen oder dem Standort der Nutzer:innen bereitstellen.
Echtzeit-Aktualisierungen:
Durch die Anbindung mit deinem CMS, kannst du Inhalte in Echtzeit aktualisieren und verteilen. Nimmst du Änderungen an Dokumenten vor, werden diese sofort an alle Ausgabekanäle gesendet. Die Portale sind meist cloud-basiert, was bedeutet, dass deine Inhalte jederzeit, überall zugänglich sind.
Analysen und Feedback:
Zudem kannst du Nutzungsdaten sammeln und analysieren. Du kannst herausfinden, welche Teile der Dokumentation am häufigsten genutzt werden, welche Fragen Nutzer:innen am häufigsten stellen etc. Diese Informationen kannst du nutzen, um eure Inhalte kontinuierlich zu verbessern.
Übrigens findest du mehr und ausgeführte Argumente in unserem dafür erstellten Whitepaper, der dir als Entscheidungsgrundlage für den Weg in Richtung moderne Softwaredokumentation dienen kann. Hier kannst du ihn runterladen.
