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:

Warum du als Führungskraft klügere Mitarbeiter einstellen solltest (und Mikromanagement dein größter Fehler ist)

Es ist einer der am häufigsten zitierten Führungsratschläge: Umgib dich mit Menschen, die klüger sind als du. Und einer der am seltensten wirklich befolgten. Warum? Weil er sich leichter sagt, als er sich anfühlt.

Unternehmenskultur frisst Agilität zum Frühstück

Zyklische Abfolgen sind an vielen Stellen im Leben beobachtbar: Wiederkehrende vier Jahreszeiten, alte Songs, die plötzlich als Cover-Versionen wieder auf den Markt kommen (Jugendliche identifizieren diese dann als "Grundform", denn sie kennen das Original nicht), erst Karottenjeans, dann wieder Hosen mit Schlag, dann wieder Karotte, in der Politik Republikaner, Demokrat, Republikaner, Demokrat..., Hardliner-Papst, Vermittler-Papst... - alles kommt in regelmäßigen Abständen wieder. So auch die Erkenntnis, was man alles tun müsste, um in Unternehmen wirklich agil arbeiten zu können. Warum aber gelingt die Installation agiler Zusammenarbeit in größeren Unternehmen bis heute so wenig zufriedenstellend? Werden dabei vielleicht Aspekte immer noch zu wenig gesehen?

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.

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.

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.

Warum Veränderungsinitiativen scheitern - und wie Du veränderungsresistente Strukturen knackst

[TL;DR] Viele Veränderungsinitiativen stossen auf harten Widerstand - nicht weil die Idee der Veränderung oder das Zielbild schlecht ist, sondern weil Organisationen wie Tensegrity-Strukturen funktionieren: hochgradig vernetzt, unter Spannung, systemisch. Wer das versteht, geht Veränderung anders an. Hast Du schon mal von Tensegrity Strukturen gehört? Nimm Dir doch mal kurz Zeit und schau Dir das Video an. Dann hast Du's sofort im Kopf. Und wenn Du die 58 Sekunden nicht hast und lieber weiterliest: Tensegrity-Strukturen sind faszinierende Gebilde aus schwebenden Stäben und Seilen, bei denen sich kein Stab direkt berührt - und trotzdem hält das ganze Ding sehr resilient gegen Störungen zusammen. Ich bin Tensegrity-Strukturen zuerst in einem ganz anderen Zusammenhang begegnet - in der Trainingslehre. Der menschliche Körper wird nämlich von einer solchen Struktur aus Zug und Druck - Muskeln, Faszien, Sehnen - permanent im Gleichgewicht gehalten. Das Elegante daran: Stabilität entsteh...

Workflow und KI - Ändert sich etwas?

Sind KI-Systeme nun Ersatz oder Ergänzung für klassische Workflowsysteme? Ich glaube nicht, dass man das direkt so vergleichen kann.

E-Mail-Vorlagen gemeinsam nutzen (Outlook)

Mittlerweile wird praktisch alle Routine-Korrespondenz in Outlook erledigt. Was liegt da näher, als ein gutes Set von Vorlagen zu erstellen und diese gemeinsam in Team zu nutzen? Leider hat Microsoft vor diesen – an sich simplen – Wunsch einige Hürden gebaut.

Wie informiert man sich über Künstliche Intelligenz?

Jeden Tag überschlagen sich die Nachrichten über die neuen Entwicklungen im Bereich Künstlicher Intelligenz. In diesem Beitrag stelle ich Quellen vor, um sich über die Hintergründe zu informieren und um den Überblick zu behalten.

Das Teamwork-Blog

Dieses Blog durchsuchen