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

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.

Selbstbewertungsfragen für den Alltag in Arbeitsgruppen aus Sicht von Mitarbeitenden

Welche Fragen können wir Mitarbeiter:innen stellen, um herauszufinden, ob agiles Arbeiten wirkt? Es gibt bereits eine Menge an Fragebögen. Aber ich bin nicht immer zufrieden damit.

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.

Agile Sternbilder: Die Entdeckung kosmischer Agilitäts-Superkräfte

Hast du dich je gefragt, ob dein Sternzeichen deine Fähigkeiten in einer agilen Arbeitsumgebung beeinflusst? In diesem Blogpost tauchen wir ein in die faszinierende Welt der Astrologie und ihre mögliche Verbindung zu modernen Arbeitsweisen. Entdecke, wie die Sterne deine agilen Stärken prägen könnten. Ob überzeugter Agilist oder neugieriger Sternzeichenliebhaber – dieser Artikel kann dir neue Perspektiven eröffnen und vielleicht sogar dein nächstes Teamprojekt inspirieren!

Microsoft Lists: mit Forms und Power Apps komfortabel mobil arbeiten

In meinem Kundenkreis sind viele Menschen, die den Arbeitsalltag nicht vorwiegend auf dem Bürostuhl sitzend verbringen, sondern "draußen" unterwegs sind. Vielleicht in Werkstätten oder im Facility-Management. Es ist so wichtig, dass die Schnittstellen zu den Abläufen im Büro gut abgestimmt sind. Microsoft 365 hat so einiges im Baukasten, man muss es nur finden und nutzen. In diesem Artikel spiele ich ein Szenario durch, das auf Microsoft Lists, Forms und - für die Ambitionierteren - Power Apps setzt.

Scrum und Hardware: Es kommt auf die Basics an

Man kann Hardwareprodukte agil entwickeln. Zum einen kommt Scrum aus der Hardwareentwicklung. Die Softwerker haben die Hardwarekonzepte auf ihre Situation übertragen. Zum anderen hat Hardwareentwicklung heute ganz viel mit Software zu tun. Gerade in frühen Phasen kann man sich mit Simulationen noch viele Wege offen halten und mehrere Pfade parallel verfolgen. In diesem Beitrag empfehle ich eine Podcastfolge und ein Buch, für alle, die mit der Geschwindigkeit ihrer Hardwareentwicklung nicht zufrieden sind.

Wie Agilität den Kundennutzen steigert - Einige Argumente für Berater:innen

In Zeiten wirtschaftlicher Unsicherheit fragen sich viele, ob agile Beratung noch eine Zukunft hat. Die Antwort liegt in der konsequenten Orientierung am Kundennutzen. Qualität setzt sich durch, wenn sie messbare Verbesserungen bei Umsatz, Kosten und Leistungsfähigkeit bewirkt, anstatt sich in Methoden und zirkulären Fragen zu verlieren. Dieser Artikel zeigt, wie agile Beratung nachhaltige Veränderungen in Unternehmen schafft und warum gerade jetzt gute Berater:innen gebraucht werden, um Organisationen widerstandsfähiger zu machen.

Prozessorientierte Dokumentation - Wie geht das?

Bestimmte Softwareprodukte brauchen eine Dokumentation, damit neue Anwender:innen schnell lernen, wie sie mit der Software arbeiten können. Aber wie entsteht diese Dokumentation? Wie lange dauert das?

Warum eine Agile Transformation keine Reise ist

Die agile Transformation wird oft als eine Reise beschrieben. Doch dieser Vergleich kann viele Unternehmen in die Irre führen oder Bilder von unpassenden Vergleichen erzeugen. Transformationen sind keine linearen Prozesse mit einem klaren Ziel, sondern komplexe und dynamische Entwicklungen. Dieser Artikel zeigt, warum Agilität kein Weg mit einem festen Endpunkt ist.

Warum bringen Warum-Fragen so wenig?

Frust! Wieder gibt's am Ende des Meetings keine Lösungen, sondern nur Diskussionen darüber, wer was warum verbockt hat. Wieder geht nichts voran. Warum passiert uns das immer wieder? (Ha! Da ist sie wieder, die Warum-Frage.)

Das Teamwork-Blog

Dieses Blog durchsuchen