Einen gleichnamigen Vortrag habe ich auf der tekom-Jahrestagung 2013 im Themenkreis “User Assistance und Software-Dokumentation” gehalten. Hier dessen zentrale Thesen und Inhalte – angelehnt an den zugehörigen Tagungsbandbeitrag. Wenn ein Bild mehr als 1000 Worte sagt, beweist ein gutes Beispiel, dass das Produkt funktioniert. Qualitativ hochwertige Beispieldaten sind nicht nur für Dokumentation, Marketingmaterial und Schulungen erforderlich. Wenn sie didaktisch und ansprechend aufbereitet sind, schaffen Beispielinhalte für den Nutzer einen Mehrwert, indem sie motivieren und einen schnellen Einstieg in komplexe Produkte ermöglichen. Dieser Vortrag zeigt, wie qualitativ hochwertige Software-Beispielinhalte einen Mehrwert schaffen und einen schnellen Einstieg in komplexe Software-Produkte auch ohne Handbuch ermöglichen. Dazu ist es hilfreich, zunächst verschiedene Formen von Demoanwendungen und Beispielinhalten zu unterscheiden:

• Blindtexte dienen als Layout-Platzhalter anstelle der endgültigen Inhalte. Typischerweise sind “Lorem ipsum” & Co. für die Leser idealweise nie sichtbar und sollten auch in Anwendungsbeispielen zugunsten von sinnvollen Beispieldaten oder wenigstens generierten Blindtexten vermieden werden.
• Beispieldaten sind Datensätze, die formal der tatsächlichen Anwendung entsprechen und für Software-Tests und für Vorführsysteme dienen, beispielsweise anonymisierte Adressdaten.
• Code-Beispiele sind unverzichtbar für Entwicklerdokumentationen und Schnittstellenreferenzen. Lauffähige Code-Beispiele, die sich möglichst an typischen Anwendungsfällen orientieren, werden von Entwicklern gern kopiert und angepasst. Obwohl auf Code-Beispiele hier nicht näher eingegangen wird, gelten die im Folgenden genannten Aspekte auch hier.
• Anwendungsbeispiele dienen als möglichst fertige Lösungsbausteine. Sie demonstrieren nicht nur typische Anwendungsfälle, sondern inspirieren die Nutzer idealerweise auch zu weiteren Einsatzmöglichkeiten der Software.
• Ein Demosystem ist eine zumeist zeitlich beschränkte, komplett lauffähige Variante des Software-Produkts und enthält Anwendungsbeispiele und Beispieldaten. Es dient zum Kennenlernen des Produkts und als Kaufanreiz.

Aufbau und Inhalte von Beispieldaten und -anwendungen

In jedem Fall muss vorausgesetzt werden, dass die Daten nutzbar, vollständig und in sich schlüssig aufgebaut sind. Für die Inhalte der Beispielanwendungen empfiehlt sich ein allgemein verständliches, anschauliches Thema, das eine möglichst geringe Fachlichkeit aufweist, z. B. bei Geschäftsprozessbeispielen ein Pizzabestell-Workflow anstelle eines spezifischen Schadenabwicklungsprozesses aus der Versicherungsbranche. Schließlich geht es darum, die Verwendung der Software zu illustrieren und den Nutzern einen spielerisch-explorativen Zugang zu diesem Produktwissen zu ermöglichen. Beispieldaten müssen klar als solche erkennbar und dürfen nicht mit produktiven Daten verwechselt oder vermischt werden.

Beispielanwendungen als Dokumentation 2.0

Gerade beim ersten Kennenlernen von Software-Produkten tendieren Nutzer zum sofortigen Ausprobieren – das Handbuch bleibt zumeist links liegen. Diesen für Technische Redakteure wenig erfreulichen Umstand gilt es zu akzeptieren und Lösungen zu finden. Eine davon ist, insbesondere anleitende Informationen zum einen in einer selbsterklärenden Software-Oberfläche, zum anderen in voll funktionalen Beispielen unterzubringen. Ein Demosystem mit Beispielanwendungen, die alle wichtigen Funktionen und Anwendungsfälle erläutern, ist die primär genutzte Informationsquelle, auch wenn der Anwender dies nicht explizit als Hilfe oder gar als Dokumentation identifizieren wird.

Keynote fürs iPad: mitgelieferte Demo-Präsentation als Anleitung

Sobald es um handlungsrelevante Informationen geht, können Beispielanwendungen das Handbuch nahezu vollständig ersetzen. Das gilt jedoch nicht für deskriptive Dokumentation wie Systembeschreibungen, Architekturübersichten etc. Ein Sonderfall für Beispielanwendungen tritt bei dokumentzentrierter Software auf. Hier bietet es sich an, ein Beispieldokument mitzuliefern, das die Nutzung erläutert und Möglichkeiten aufzeigt, etwa bei der Präsentations-App “Keynote für iOS”, die anleitende Beispielfolien enthält. Hier ist das Beispieldokument bereits die Benutzerdokumentation (siehe Abbildung).

Mehrwert durch Beispiele

Tatsächlich sind Beispielanwendungen mehr als Dokumentation. Wenn die Software über das Internet (bzw. einen Online-Shop) vertrieben wird, ist ein sorgfältig mit Beispielanwendungen bestücktes Demosystem im Gegensatz zu Handbüchern sogar oft kaufentscheidend. Aus diesem Grund erhalten Demosysteme auch von Vertrieb und Marketing immer mehr Aufmerksamkeit. Nicht nur aus Verkaufssicht sinnvoll ist es, auch für optionale Komponenten Beispielanwendungen als “Appetitanreger” zu integrieren, um zusätzliche Lizenzeinnahmen zu generieren. Individuelle Beispielanwendungen ermöglichen die emotionale Ansprache von Nutzern, sei es über humorvolle oder spielerisch aufgebaute Inhalte oder mit Maskottchen, die eingebunden werden und eine Markenbindung herstellen. Als Positivbeispiel ist hier die Aufgabenverwaltung Atlassian JIRA zu nennen, deren fiktives Beispielprojekt “Angry Nerds” mit liebevoll gestalteten Comicfiguren weltweit Fans gewinnt – T-Shirts mit diesen Motiven sind heiß begehrt.

Bedeutung von Beispielanwendungen im Unternehmen

Beispieldaten und -anwendungen für Software werden an vielen Stellen im Unternehmen benötigt und können idealerweise durchgängig wiederverwendet werden:

• Die Technische Redaktion benötigt Beispieldaten für die Dokumentation, etwa für Bildschirmfotos und Beispielangaben in Tutorials.
• Marketing und Vertrieb benötigen Vorführsysteme und sofort übernehmbare Anwendungen für Produktpräsentationen und Videos sowie für Abbildungen auf der Website und in Broschüren.
• Die Schulungsabteilung benötigt ein Schulungssystem mit Beispieldaten und -anwendungen.
• Die Entwicklungsabteilung muss ein vollwertiges Demosystem bereitstellen. Zudem kann die Qualitätssicherung mit Beispieldaten und -anwendungen näher am tatsächlichen Nutzungskontext erfolgen und man erhält eine Basis für Testsysteme.
• Im Consulting dienen Beispielanwendungen, z. B. in Form von Entwicklungsmustern in Demosystemen, oft als Basis für den Produktivbetrieb und werden in Kundenprojekten verwendet. Dies setzt sorgfältig zusammengestellte Beispielanwendungen zwingend voraus.

Die Beispielanwendung als TR-Domäne

Beispielanwendungen sind eine eigenständige Dokumentationsart, die aber häufig von Software-Entwicklern betreut wird. Diese sind aber oft damit überfordert, zielgruppengerechte, hilfreiche und didaktisch sinnvolle oder sogar individuelle Beispielanwendungen zu schaffen. Nichts liegt daher näher, als dieses Thema im Bereich der Technischen Redaktion anzusiedeln, um Mehrfachaufwände, didaktische Mängel und Inkonsistenzen zu vermeiden und Dokumentation und Beispielanwendungen zentral zu verwalten. Dies erfordert jedoch seitens der Technischen Redakteure eine hohe Produktkompetenz bis hin zur komplexen Anwendungsebene, um entsprechende Beispiele nicht nur verstehen, sondern selbst entwickeln zu können.

Fazit und Ausblick

Beispieldaten/-anwendungen sollen als Bestandteil der User Assistance und der Dokumentation für Software begriffen werden. Dem App-Trend folgend werden Software-Produkte zukünftig mit immer weniger Begleitdokumentation ausgeliefert. Qualitativ hochwertige Beispieldaten und -anwendungen erhalten dann einen noch höheren Stellenwert. Der zunächst hohe Erstellungsaufwand für herausragende Beispielanwendungen ist aber allein schon durch hohe Synergieeffekte bei der Dokumentationserstellung zu rechtfertigen. Und wenn der Vertrieb das Demosystem als Verkaufsargument entdeckt, nimmt dessen Wichtigkeit weiter zu. Begreifen Technische Redakteure das Thema als ihre Aufgabe, ergibt sich der konzeptionelle Bedarf, Dokumentation und Beispielanwendungen gemeinsam zu verwalten, und die technische Herausforderung, dies effizient umzusetzen.

Lesegefahr zum Thema:

Folien zum Vortrag auf der tekom-Jahrestagung bei Slideshare