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

Wie lassen sich Ergebnisse definieren? - Drei Beispiele (WBS, CBP und BDN)

Ich habe schon darüber geschrieben, warum das Definieren von Ergebnissen so wichtig ist. Es lenkt die Aufmerksamkeit des Projektteams auf die eigentlichen Ziele. Aber was sind eigentlich Projektergebnisse? In diesem Beitrag stelle ich drei Methoden vor, um leichter an Ergebnisse zu kommen.

Teamleitungen gesucht

Was macht Teams erfolgreich? Kann man das lernen? Ab Herbst starten unsere Kurse für aktuelle und künftige Teamleitungen. Jetzt gibt es die Gelegenheit, den Kurs zu testen.

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.

Microsoft Copilot - Notebook, Pages, Agents und mehr

Es tut sich sehr viel an der Copilot Front. Gefühlt entwickelt Microsoft mit aller Kraft die KI-Anwendung weiter. Mit dem letzten Update hat sich die Microsoft-Startseite stark verändert. Hier zeige ich, was sich hinter all den Begrifflichkeiten verbirgt und was davon alltagstauglich ist.

Nachschau zum Lean Coffee-Spezial "Agil einfach machen" (Interaktive Buchvorstellung)

Bei unserem Lean Coffee-Spezial Ende Mai waren wir von Lean Coffee Karlsruhe/Frankfurt Zeugen einer Buchvorstellung, doch nicht nur das – natürlich gab es auch einen nicht unbeträchtlichen Anteil an eigener Aktion, denn bei unseren Spezialterminen ist traditionell „Teilgabe“ angesagt. Das Autorenduo Christian Baron und Janick Oswald zeigte uns, was es mit „Agil einfach machen“ auf sich hat.

Deutsche Transparenz und was das mit unserer Agilität zu tun haben könnte

Nicht wenige Konzepte im agilen Umfeld haben mit "Transparenz" zu tun. Es schimmert an einigen Stellen hindurch, dass es gerade in unserem Land schwierig sein könnte, echte agile Zusammenarbeit durch u. a. Förderung von Transparenz zu erreichen. Womit das zu tun haben könnte, ist Thema dieses Artikels.

Wenn es mal gerade etwas schwierig bei Kund:innen wird… Zwei Fragen, die uns helfen, unsere Strategie mit unseren Kund:innen abzusprechen.

Seit 2024 organisieren Bob Galen und ich eine Masterclass für agile Coaches. Wir möchten die Ausbildung von agilen Coaches verbessern und ihnen Techniken mitgeben, mit denen sie bei ihren Kund:innen etwas einfacher haben. Bisher haben wir in vier Durchgängen mit jeweils 14 Modulen ungefähr 70 Extraordinarily Badass Agile Coaches ausgebildet (/1/). In diesem Blogpost möchte ich ein paar Erfahrungen und simple Techniken aus der Masterclass teilen, wie wir unsere Strategie besser abstimmen können. Sie beschränken sich nicht auf agiles Coaching – das ist nur das Setting.

Kleine Organisationsveränderungen, die direktes Feedback erzeugen

Große Veränderungen sind in einer Organisation schwer zu messen. Oft liegt zwischen Ursache und Wirkung ein langer Zeitraum, sodass die Umsetzer:innen nicht wissen, was genau gewirkt hat. Hier ist eine Liste mit kleinen Maßnahmen, die schnell etwas zurückmelden.

Schätzungen sind schätzungsweise überschätzte Schätze

"Wer viel misst, misst viel Mist." Zumindest ist diese Gefahr gegeben. Entweder misst man z. B. Mist, weil man zu früh zu KPIs zur Messung von Ergebnissen greift, oder aber man greift zu den falschen KPIs, die gar nicht das messen, was man wissen möchte. Einst war agiles Arbeiten der alternative Ansatz, aber inzwischen gibt es auch für einige Details dessen, was in Konzernen als "agil" praktiziert wird, einleuchtende alternative Ideen, die bis heute noch nicht so richtig auf die große Bühne vorgedrungen zu sein scheinen.

Agil sein heißt nicht, unternehmerisch zu denken

Die Diskussion, ob Agilität ein „Hype“ war, der nun vorüber ist. Ob wir schon im „Post-agilen Zeitalter“ leben. Und wenn ja, wer dafür verantwortlich ist: diese Diskussion nehme ich jetzt schon seit etwa anderthalb Jahren wahr, und sie geht auch aktuell weiter. In meiner Branche wird Agilität weiter gebraucht Ich bin in der speziellen Situation, dass ich beruflich aus dem öffentlichen Dienst komme und auch seit meinem Ausscheiden vor 15 Jahren weiterhin vor allem Kunden im öffentlichen Bereich berate. Also auf einem Parkett, das normalerweise nicht mit den Anliegen des Agilen Manifests verbunden wird: der Produktion von Software für gewerbliche Kunden in einem unsicheren Umfeld. Auf diesem scheinbar „exotischen“ Feld hat sich in den vergangenen sechs bis acht Jahren bei vielen Verwaltungen die Erkenntnis verbreitet, dass agile Vorgehensweisen bei den anstehenden Transformationen für sie sinnvoll sein können. Denn auch Projekte z.B. die „Digitalisierung der Verwaltung“ (ein völlig ...

Das Teamwork-Blog

Dieses Blog durchsuchen