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.

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!

Building Bridges

How many times have I rolled my eyes at the assertion, “But, you can’t build a bridge with Scrum”? The claim annoys as much for its misunderstanding of Scrum as for its naïve view of projects. Curiously enough, I recently discovered support for Scrum in a recent book about big projects. Maybe you can build a bridge with Scrum after all.

Den passenden Job finden

Hier teile ich, wie ich daran arbeite, endlich den richtigen Job zu finden. Kleingedrucktes: Dieser Artikel richtet sich (natürlich) an jene, die gerade in der luxuriösen Position sind, dass sie nicht jedes Angebot annehmen müssen. Anstatt von Engagement zu Engagement zu hetzen und frustriert zu sein über Konzernstrukturen, fehlende Ausrichtung und die Erkenntnis, dass in einem selbst beständig die Hintergrundfrage nagt, ob es das ist, womit man seine immer knapper werdende Lebenszeit wirklich verbringen möchte, gibt es manchmal auch die Möglichkeit, die nächste berufliche Station etwas nachhaltiger auszusuchen - auch, um tatsächlich (etwas) mehr beitragen zu können.

Die Microsoft Teams-Not-To-Do-Liste

Viele hoffen, dass es für die Einrichtung von Microsoft Teams den Königsweg gibt, den perfekten Plan – doch den gibt es leider (oder glücklicherweise?) nicht. Genauso wenig, wie es jemals einen Masterplan für die Organisation von Gruppenlaufwerken gab, gibt oder je geben wird. Was gut und vernünftig ist hängt von vielen Faktoren und ganz besonders den Unternehmensprozessen ab. Sicher ist nur eines: Von alleine entsteht keine vernünftige Struktur und schon gar keine Ordnung. Dafür braucht es klare Entscheidungen.

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?

Agilität ist tot. Ausgerechnet jetzt?

Agilität wird zurückgefahren, Hierarchien kehren zurück. Doch ist das wirklich der richtige Weg in einer Welt, die immer unberechenbarer wird? Oder erleben wir gerade eine riskante Rolle rückwärts?

Wie beschreibt man einen Workshop für eine Konferenz?

Konferenzen bieten immer ein gutes Forum, um sein Wissen und seine Erfahrungen zu teilen. Was für die Vortragenden selbstverständlich scheint, ist für die Besucher:innen oft unverständlich. Wie können Vortragende ihren Workshop in 2-3 Sätzen beschreiben, damit die Besucher:innen schnell einschätzen können, er sich für sie lohnt?

Der Softwareeisberg, die Softwarepyramide - Wie sprechen wir über neue Software?

Software ist aus den Geschäftsprozessen vieler Unternehmen nicht mehr wegzudenken. Sie verwaltet Kunden- und Produktdaten. Sie automatisiert Abläufe und verhindert Fehler. Aber Software veraltet. Was machen wir, wenn wir Unternehmenssoftware erneuern müssen? Von den ersten Konzepten bis zum ersten Release ist es ein weiter Weg, mit vielen Entscheidungen. Wie sprechen wir über diese Entscheidungen?

Das Teamwork-Blog

Dieses Blog durchsuchen