Gemeinsam eine Anwenderdokumentation erstellen

Unternehmenssoftware ist ein wichtiges Bindeglied zwischen Anwenderinnen und Anwendern, den Unternehmensprozessen und den Ergebnissen. Normalerweise schreibt der Hersteller der Software die Dokumentation für diejenigen, die die Software benutzen. Wenn die Software allerdings stark angepasst wurde, muss die Dokumentation von denen kommen, die die Prozessmaschine am besten verstehen - den Anwenderinnen und Anwendern. Wie könnte man das praktisch machen?

Es gibt zu diesem Beitrag eine Ergänzung um prozessorientierte Dokumentation.

Es ist hilfreich, eine Dokumentation zu erstellen, die sich an den Prozessen, also an der Bedienung der Software orientiert. Beispiele für Prozesse:

Einen Kunden anlegen (oder einen Geschäftspartner anlegen)
Ein neues Projekt anlegen
Eine Buchung auslösen
Eine Zahlung freigeben

Manchmal ist es praktisch, mehrere Prozesse zu einer Prozessgruppe zusammenzufassen.

Ein gutes Verständnis der Zusammenhänge der Daten ist auch wichtig. Die Fachleute nennen das ein Domänenmodell, ein Datenbankmodell oder eine Informationsarchitektur. Ich finde Domänenmodelle ganz praktisch. (Wolf hat dazu bereits im Jahr 2015 einen Beitrag geschrieben.) Diese Modelle sind meist Bilder von Zusammenhängen. Wir können die Details gut in einem Glossar beschreiben.

Wie entsteht die Dokumentation? Dazu gibt es zwei Varianten: entweder wir dokumentieren fortlaufend oder wir starten verschiedene Aktionen, um die Dokumentation initial zu erstellen oder auf den neusten Stand zu bringen.

Variante 1: Fortlaufende Dokumentation

Bei dieser Variante wird jede Änderung an der Software oder an einer Einstellung direkt dokumentiert. Die Benutzer:innen, die die Änderung in Auftrag geben, fragen sich immer: "Welches Dokument oder welche Wiki-Seite müssen wir für diese Änderung anpassen?"

Kommt ein neues Datenobjekt oder eine ganz neue Datenkategorie dazu, müssen wir das Datenmodell und das Glossar ergänzen.
Wenn Begriffe konkretisiert oder erweitertert werden, wird das Glossar aktualisiert.
Wenn sich die Abläufe ändern, passen wir die Prozessbeschreibungen an.
Ggf. müssen weitere Übersichtsdokumente angepasst werden
Manchmal ist es gut, ein Dokument mit häufig gestellten Fragen (FAQ) oder eine Wissensdatenbank (engl. Knowledge Base KB) zu führen.

Was ist, wenn wir keine ausreichende Dokumentation haben? Dann müssen wir Aktionen starten, durch die wir die Dokumentation auf den aktuellen Stand bringen. Darum geht es bei Variante 2.

Variante 2: Book Sprint

Ein Book Sprint ist eine Art Hau-Ruck-Aktion, bei der mehrere Expertinnen und Experten gemeinsam ein Buch schreiben. Diese Arbeit gleicht einem Hackathon. Allerdings wird in einem Hackathon Software erstellt und eher selten die Dokumentation.

Tom Ottway hat eine Anleitung für einen Book Sprint geschrieben:

Ein Book Sprint dauert mindestens 3 Tage, aber nie mehr als 5 Tage.
Concept Mapping zu Beginn: Alle Ideen visualisieren und in eine Ordnung bringen
Jeder sucht sich die Ideen aus, die er schreiben möchte. Ideen, die von keinem ausformuliert werden, werden gelöscht.
Schreiben und verbessern
Veröffentlichen

Ein Book Sprint kann man am Anfang wie eine Open Space moderieren. Wenn es dann einen Plan gibt, kann in festen Timeboxen gearbeitet werden. Ich habe gute Erfahrungen mit 20 und 60 Minuten Timebox zum Schreiben gemacht.

Aber welche Themen gehen wir zuerst an? Ich würde mich an zwei Szenarien orientieren:

Welche Informationen braucht ein neuer Anwender unbedingt, um starten zu können?
Welche Informationen sollen als erstes in einer andere Sprache übersetzt werden, wenn wir den Kreis der Anwender international erweitern?

Man muss übrigens nicht immer alles ausführlich beschreiben. Oft sind Anwender schon zufrieden, wenn sie den Grundablauf und die wesentlichen Begriffe kennen. Dann brauchen sie noch Ansprechpartner, an die sie sich für Fragen wenden können.

Wer schreibt?

Ich würde erfahrene und neue Anwender zusammenbringen. Die Erfahrenen können Dinge gut erklären. Aber sie wissen gar nicht, was sie alles wissen. Die Neuen können gut Fragen stellen. Sie finden Lücken.

Gute Beispiele für kollaborativ erstellte Dokumentation finden sich übrigens bei den FLOSS Manuals. Die Dokumentation von ERPNext ist auch gut aufgebaut.

Viel Spaß beim Schreiben.

Kommentare

Beliebte Posts aus diesem Blog

Die Profi-Tools im Windows-Explorer

Haben Sie bei der Urlaubsvertretung sich manches Mal geärgert, wenn Sie Dateien gesucht haben, die ein Teammitglied abgelegt hat? Die Suche im Explorer funktioniert tadellos, aber manchmal sollte man den Suchbegriff noch ein bisschen genauer fassen können. Z.B. mit UND oder ODER oder NICHT... Das geht so einfach, dann man von alleine kaum drauf kommt:

Was macht ein agiles Project Management Office (PMO)?

Was macht eigentlich ein Projektmanagementoffice, insbesondere wenn es auch agile Projekte in der Organisation gibt? Muss man es abschaffen, wenn alle Projekte agil umgesetzt werden? Was machen die Personen, die im PMO tätig sind? Hier ist ein Vorschlag für eine agile Ausgestaltung eines PMO.

Microsoft Teams: Die neuen Besprechungsnotizen - Loop-Komponenten

Haben Sie in letzter Zeit in einer Teams-Besprechung die Notizen geöffnet? Dort sind inzwischen die Loop-Komponenten hinterlegt. Die sind zwar etwas nützlicher als das, was zuvor zur Verfügung stand. Trotzdem ist noch Luft nach oben. Und es gibt sogar einige ernstzunehmende Stolperfallen. Hier ein erster, kritischer Blick auf das was Sie damit tun können. Und auch darauf, was Sie besser sein lassen.

Das Ubongo Flow Game

Spiele bieten eine gute Gelegenheit, zeitliche Erfahrungen zu verdichten und gemeinsam zu lernen. Karl Scotland und Sallyann Freudenberg haben im Mai 2014 das Lego Flow Game veröffentlicht. Wir haben die Spielidee übernommen, aber das Spielmaterial gewechselt. Statt Legosteinen benutzen wir Material aus Grzegorz Rejchtmans Ubongo-Spiel. Hier präsentieren wir die Anleitung für das Ubongo Flow Game.

Kategorien in Outlook - für das Team nutzen

Kennen Sie die Kategorien in Outlook? Nutzen Sie diese? Wenn ja wofür? Wenn ich diese Fragen im Seminar stelle, sehe ich oft hochgezogene Augenbrauen. Kaum jemand weiß, was man eigentlich mit diesen Kategorien machen kann und wofür sie nützlich sind. Dieser Blogartikel stellt sie Ihnen vor.

Rebellieren für den Wandel: die 8 Regeln des totalen Stillstandes von Prof. Dr. Peter Kruse

In einem legendärem Vortrag skizzierte Peter Kruse 8 Regeln des totalen Stillstands. Ihm zufolge wurden die Regeln entwickelt, um Managern und Führungskräften dabei zu helfen, Bereiche mit potenziellem Widerstand gegen Veränderungen zu erkennen und Menschen auf strukturierte Weise durch den Veränderungsprozess zu führen.

E-Mails, Fragmentierung der Arbeit – und dann auch noch KI

Die Einführung von KI in die Arbeitswelt wird von zahlreichen Preisungen ihrer Vorteile begleitet. Sind diese realistisch? Ein Blick zurück auf vergangene Phasen der Digitalisierung lässt erkennen, dass versprochene Erleichterungen in der Praxis nicht eintraten. Im Gegenteil nahm die Produktivität bei Wissensarbeitern ab, der Stress nahm zu und wichtige Herausforderungen verschwinden aus dem Blickfeld. – Was könnten juns diese Erfahrungen für unseren Umgang mit KI lehren?

Erfahrung mit Vibe-Coding - und warum das keine Teamprobleme löst

Die KI-Werkzeuge zum Erstellen von Werkzeugen für die tägliche Arbeit werden immer besser. Die selbstgestrickten Tools erleichtern die eigene Arbeit. Aber für den Einsatz im Team fehlt noch etwas.

Outlook-Aufgabenliste: bitte nicht die Aufgaben des ganzen Teams!

Am Tag der Arbeit kommt eine Lösung, nach der ich schon so oft gefragt wurde: Wie schaffe ich es, dass meine Outlook-Aufgabenliste nur meine eigenen Aufgaben anzeigt und nicht auch die E-Mails, die meine Kollegen gekennzeichnet haben oder Aufgaben, die einfach in einem gemeinsamen Postfach stehen?

Und jetzt alle zusammen! Teams - OneNote - Aufgaben - To Do

Ein Meeting jagt das nächste. Sich da nicht zu verzetteln, wird im Zeitalter virtueller Besprechungen noch anspruchsvoller. Kein Wunder, dass im Zusammenhang mit Microsoft 365 zwei Fragen besonders häufig auftauchen: Wie dokumentiert man Besprechungen gut? Was hilft, offene Aufgaben nachzuhalten? Eine gute Lösung: Das in MS Teams integrierte OneNote-Notizbuch als gemeinsame Plattform auch für den Aufgabenüberblick zu nutzen.

Das Teamwork-Blog

Dieses Blog durchsuchen