Bei der Softwaredokumentation gilt dasselbe, was auch beim Gestalten einer Bedienungsanleitung im Fokus steht: Wir schreiben für den Nutzer. Hört sich schon mal vernünftig an, bedarf aber der Vertiefung. Gibt es doch unterschiedliche Benutzergruppen:

​

• Endbenutzer, also Personen, die die Software persönlich oder beruflich nutzen, wie wir alle bei vielen Gelegenheiten, ob bei Textprogramm oder Fotokamera.

• Personen, die Computersysteme oder Netzwerke verwalten, Administratoren.

• Die Experten selbst, die Softwareentwickler.

​

(Falls Sie die Ausführungen zu einer anderen Zeit lesen möchten, hier die PDF dazu.)

 

Benutzergruppe deutlich differenzieren

​

Die Differenzierung geht weiter: Es können Beschäftigte in einem Unternehmen sein, die eine ERP-Software oder ein CAD-Programm nutzen oder eben die Privatpersonen. Die Personen können mit einem Seminar in eine Software eingeführt werden. Oder aber es sind Privatleute, die sich so gut wie gar nicht in das System eindenken möchten. Beim Administrator kann einiges an Fachwissen und Fachvokabular vorausgesetzt werden.

 

Beim Entwickler geht es darum, die Brücke zu schlagen zwischen Fachwissen und Nutzervermittlung. Vor allem in dem Moment, wo Softwareentwicklung und Dokumentationsentwicklung, also das Schreiben der Softwaredokumentation, Hand in Hand gehen.

 

Was mir dabei wichtig ist: Den Ball immer flach halten. Niemand will sich mit komplizierten Begriffen und komplexen Formulierungen herumschlagen. Mehr dazu finden Sie unter Technisches Schreiben.

​

Meine User definieren und gezielt ansprechen – auf Augenhöhe

 

Ja, die Nutzer der Software sind vielgestaltig, ebenfalls deren bevorzugter Zugang. Wie bereits erwähnt sitzen Angestellte in einem Unternehmen in der Regel vor einem PC oder einem Laptop, benötigen vielleicht hie und da eine PDF oder Hardcopys. Letzteres wahrscheinlich sogar öfters. Junge Leute bevorzugen das Smartphone zur Informationsbeschaffung, wieder andere ein Tablet.

 

Recherche gehört dazu, wenn wir unsere Nutzgruppe definieren, reflektieren und festlegen. Mit dem Ergebnis arbeiten wir, indem wir einzelne User oder Usergruppen passend ansprechen.

 

Zuerst einmal geht es um systematische Vermittlung – wie beim Schreiben einer Handlungsaufforderung, siehe Bedienungsanleitung. Immer sollen Inhalte systematisch vermittelt werden. Und, das gilt auch bei einer Bedieungsanleitung, unterteilt in gut verdauliche Happen.

 

​

Stichwort Happen und gut verdaulich: Hier setzt das topic-basierte Schreiben an. Mehr Info beispielsweise hier.

​

Schreiben in gut verträglichen Happen – topic-basiertes Texten

​

An und für sich gebe ich gerne Regeln an die Hand. Doch Ihnen etwas von Kohäsion, Kohärenz und Konsistenz zu erzählen, ist viel zu theoretisch. Auch Vorgaben zur Länge einer Antwort, wenn bei einer Onlinehilfe ein Frage gestellt wird, bringt Sie nicht weiter.

​

Mein Toptipp: Ich kann Ihnen versichern, dass ich sehr viel Erfahrung mit dem Kürzen von Artikeln, dem Verfassen von Überschriften oder auch Bildunterschriften habe. Mancher Kollege in der Technischen Redaktion war dankbar, wenn er nicht einen Textbaustein vergrößern musste, sondern ich ihm den Text angepasst habe.

 

Daher: Nehmen Sie Kontakt mit mir auf. Melden Sie sich bei mir! Ich kann Ihnen zeigen wie Sie Informationen in verträgliche Happen aufteilen. Üben müssen Sie selbst, vielleicht können Sie sich dazu auch mit einem Chatbot zusammentun.

​

UX-Writing / Microcopy – mit unseren Nutzern plaudern

​

Kurz, informativ, verständlich. Die Formel habe ich bereits beim Technischen Schreiben an die Hand gegeben. Doch geht es im Folgenden weniger um Kürze, sondern um Verständlichkeit, besser noch den Draht zu unserem User.

​

Der Sprachstil bei Ansprache der Nutzer kann und soll ‚ansprechend‘ sein. Der Fachbegriff dafür ist UX-Writing. UX steht für User Experience. Gemeint sind die Eindrücke und das Erleben des Nutzers, wenn er sich mit dem Produkt oder dem Service beschäftigt. Mehr Info bei Wikipedia.

 

Eingesetzt wird UX-Writing auf der Bedieneroberfläche digitaler Systeme. Als kurze Hilfen, Nachfragen, Weiterleitungen. Dazu gesellt sich der Begriff Microcopy: kleine Handlungsanweisungen, die im Dienste der User Experience stehen. Mehr Info dazu.

​

Damit Nutzer sich gerne mit der Software beschäftigen, versetzen wir uns wieder in ihre Lage. Wenn möglich schon bei Entwicklung der Software.

​

• Wer nutzt die Software typischerweise?

• Wie verhalten sich Menschen im Allgemeinen?

• Wie aufmerksam und motiviert sind sie?

​

Hinzu tritt das besondere Erleben für die Nutzer.

 

Umgangssprache, passender Jargon und Füllwörter

​

Damit das eintritt, gibt es Mittel und Wege, wie sollte es anders sein. Eine davon ist die Umgangssprache.

 

• Umgangssprache, unsere Alltagssprache ist locker, ohne fachliche oder bürokratische Verbiegungen, sie ist uns vertraut, wir fühlen uns wohl mit ihr.

• So genannte Modalpartikel unterstützen den Eindruck von Umgangssprache. Das sind  Füllwörter wie: ja, doch, möglicherweise, mal, dann ... Es heißt dann (!) nicht: ‚Hier klicken‘, sondern ‚Schauen Sie doch mal vorbei‘; ‚Nehmen Sie einfach Kontakt mit mir auf.‘

• Wortwahl ist auch ein Thema, mit Wörtern drücken Personen ihre Gruppenzugehörigkeit aus. Man kann auch von Fachjargon oder Jargon sprechen. 
  Fachbegriffe aus der Computerszene sind etwa ‚Buzzword‘, ‚Sitemap‘ ‚Plug-in‘.
  Digital Natives (junge Leute, die digital großgeworden sind) benutzen in Chats oder Foren Abkürzungen wie OMG = o my god oder englische Begriffe wie cringe = besonders peinlich.

• Locker kommt das ‚Du‘ daher, anstelle von ‚Sie‘. Auch ich habe überlegt, ob ich Sie auf meiner Website vielleicht mit Du ansprechen sollte. Konnte mich aber noch nicht dazu durchringen.

• Was ich aber pflege ist das Wir. Geht auch beim UX-Writing, etwa als: ‚Wir kümmern uns darum‘.

 

Auch ich würde mich gerne kümmern, und zwar um Sie. Daher: Melden Sie sich bei mir, bestimmt gibt es Fragen. Ich freue mich auf ein Informationsgespräch.

​

Normen für die Softwaredokumentation

 

Ich will Sie nicht mit Normen langweilen. Doch sollen die Vorgaben ja eine Hilfestellung bieten. In der Normenreihe ISO/IEC/IEEE 2651x ist die Rede von Anwenderinformationen (Information for Users). Es handelt sich um eine Reihe und jede nimmt einen Aspekt bei der Informationsentwicklung auf, also beim Erstellen der Dokumentation, mit Rollen, Aufgaben und Anforderungen.

​

Eine kleine Auswahl

​

• ISO/IEC/IEEE 26512 System- und Software-Engineering – Anforderungen für Ankäufer und Lieferanten der Benutzerdokumentation. Die Norm regelt die Zusammenarbeit zwischen dem, der eine Dokumentation in Auftrag gibt und demjenigen, der sie erstellt. Für beide Parteien, Auftraggeber und Auftragnehmer, sind der Norm Checklisten angefügt.

• ISO/IEC 26514 Informationstechnik – Software und System-Engineering – Anforderungen an Designer und Entwickler von Benutzerdokumentationen. Das sind Vorgaben für das Anfertigen der Dokumentation und für das Produkt, also die Dokumentation selbst.

• ISO/IEC/IEEE 26515 System- und Software-Engineering – Entwicklung von Benutzerdokumentation in einem agilen Umfeld. In einem agilen Umfeld werden vielleicht User-Storys eingesetzt, also kurze formlose Beschreibungen einer Funktion aus Nutzersicht. Das Anfertigen der Dokumenation wird mit Backlogs, Aufgaben zum Abarbeiten, angegangen. Es wird in Sprints gearbeitet: Zeitvorgaben werden vereinbart zum Erledigen von Aufgaben. In der Norm wird auch aufgezeigt, wie Dokumentationserstellung und Produktentwicklung Hand in Hand arbeiten können.

​

In Vorbereitung sind ISO/IEC/IEEE 26516 und ISO/IEC/IEEE 26517, sind noch in Vorbereitung. In der ersten geht es um die Produktion von Videos, in der zweiten um User Assistance für mobile Anwendungen.

​

Die Normen können auch für die Erstellung anderer Dokumentationen ein Blueprint sein.

Nicht zuletzt ist es doch so, dass Softwaredokumentation immer wichtiger wird, weil immer mehr Geräte und Anlagen über Software gesteuert werden.

​

Haben Sie bis hierhin Fragen? Melden Sie sich bei mir! Wir können jederzeit ein Informationsgespräch führen.

​

Hier finden Sie die Ausführungen zum Herunterladen als PDF.