The power of pairing

Paar-Dokumentation bei einem Übergabe-Projekt

Christine Hennig, Wolfram Eifler

  1. September 2020

Einführung

Pair documentation sollte doch keine neue Idee gegenüber Pair programming sein – dachten wir.
Die Internet-Recherche zum Thema “pair documentation” lieferte ein mageres Ergebnis.

  • Einen Praxisbericht über 50 Stunden gemeinsame Dokumentation in der Open Source Community ([1]).
  • Eine empirische Studie über die Erstellung einer SRS (software/system requirements specification) als Einzelperson versus als Team ([2])

Hier unsere eigenen Erfahrungen mit dem Thema.

Anlaß war die Arbeits-Übergabe eines Mitarbeiters bei Verlassen des Unternehmens und die Sicherung des erarbeiteten Wissensstandes. Bestandteil der Übergabe war ein Prototyp bzw. Referenz-Implementierung in einem fortgeschrittenen Stadium. Er umfasste mehrere umfangreiche Technologie-Stacks.

Zur Verfügung stand ein Dokumentations-System im Intranet mit einer MediaWiki-Installation. Alle Dokumente sind als einzelne oder Verbund mehrerer Wiki-Seiten im System abgelegt.
Jedes Thema befindet sich in einem definierten Zustand, der von “Inkubator” bis “Freigabe” über mehrere Review-Zyklen läuft. Die Arbeiten fanden während der Corona-Pandemie im Homeoffice statt.

Beschrieben ist zum einen unser initialer Plan und zum anderen unsere Erfahrungen.

Hier der Plan

Ausgangslage:

  • Ein Mitarbeiter verlässt die Firma.
  • Mit den verbleibenden Arbeitsstunden ist eine möglichst vollständige Übergabe zu bewerkstelligen.

Lösungsansatz:

  • Pingpong zwischen Mitarbeiter (Contentproduktion / MA) und Redakteurin (Qualitätssicherung / QS).
  • Der redaktionelle Ablauf ist frei von Loops. So wird ein unnötiges Abgleiten in Details vermieden.
  • Die einzelnen Arbeitsschritte sind mit einem geschätzten Zeitkontingent hinterlegt.

Planung:

  • Die dokumentarisch zu bearbeitenden Themen werden im Vorfeld aufgelistet.
  • Jedes Thema durchläuft den nachfolgend genannten Arbeitsfluss.
  • Zu Beginn ist die Anzahl der zu bearbeitenden Themen mit der noch zur Verfügung stehenden Zeit abzustimmen.
  • Die verfügbare Zeit wird zu Beginn realistisch auf die Themen verteilt. Die Freiheitsgrade sind Detailtiefe, Markierung als optional und ggf. Streichung des jeweiligen Themas.

Arbeitsfluss je Thema:

NummerStundenWerZustandWas
1.01QSInkubatorSeite im System anlegen, (ggf. vorläufigen) Titel vergeben
1.11MASammelnMaterial sammeln
1.21MAOrdnenBezug zu existierender Dokumentation herstellen
1.33MAOrdnenStrukturieren/Gliedern
2.01QSPreviewStruktur auf Plausibilität kontrollieren
3.010MAAngefangenschreiben, schreiben schreiben
4.05QSReview1Inhaltlich, strukturell, Korrektheit, Konsistenz, Aktualität
5.03QS + MAHands-On Doku gegen techn. System halten, Lücken aufspüren usw.
6.04MAErgänzen1Vervollständigen, ggf. Struktur verbessern
7.03QSReview2Inhalt, Struktur
8.03MAErgänzen2Vervollständigen, ggf. Struktur verbessern
9.02QSReview3Rechtschreibung, Grammatik, tote Links
10.01QSFreigabeFertig

Ergebnis:

  • Alle geplanten Themen sind grundsätzlich bearbeitet.
  • Kein Thema ist wegen Detailversessenheit untergegangen.
  • Es ergibt sich eine Dokumentation, die Nachfolgern einen sinnvollen Ansatzpunkt liefert, um am Thema weiterzuarbeiten.

Dort die Realität

Wie immer kommt es (ein wenig) anders. Zu Beginn implementierten wir einen Backup-Mechanismus zur Sicherung der Doku-Zwischenstände.

Nach unserer Planung erfordert Punkt 3 (Schreiben, schreiben, schreiben) knapp die Hälfte der Zeit. Das entsprach der Realität.

Ab Punkt 5 (Hands-On) arbeiteten wir dann fast nur noch gemeinsam an der Doku. Die geplante Zeit wurde dazu in etwa wie erwartet benötigt, jedoch ergab sich häufig parallele Arbeit im selben Ablaufpunkt an mehreren miteinander verknüpften Themen. Außerdem justierten wir regelmäßig die verbleibenden Arbeiten nach Priorität und Zeitkontingent, teilweise auch in ihrer Struktur.

Die Reviewerin / QS-Verantwortliche hatte natürlich viele Fragen, das ist schließlich ihr Job. Die Fragen führten dazu, dass die Doku viel verständlicher und besser strukturiert wurde. Jede Rückfrage wurde genutzt, um Form und Struktur der Beschreibung zu optimieren. Die Zielvorstellung dabei war, den hinterfragten Sachverhalt noch klarer zu beschreiben.

Wir arbeiteten die Änderungen abwechselnd ein. Die Hands-On Sitzungen wurden mal von der QS, mal vom Mitarbeiter durchgeführt. Die zweite Person passte jeweils auf, dass alles richtig getippt wird und bei jedem Kommandobeispiel klar ist, was damit bezweckt wird und ob dies auch angemessen aus der Doku hervorgeht.

Dabei ging es dann direkt an den Prototyp, ohne ihn kaputtzumachen. Natürlich hatten wir ein Backup für den Notfall.

Aufkommende weitere Themen, Anmerkungen und Wünsche, die den aktuellen Rahmen sprengten, wurden fortlaufend an das Ende einer ToDo Liste angehängt.
Diese Abgrenzung entlastete den Mitarbeiter von Unterbrechungen beim Schreiben, ohne dass Thematiken verlorengingen. Die Liste wurde wöchentlich priorisiert (must, should, could, won’t [3]) sowie mit dem erreichten Fortschritt und Zeitplan abgeglichen.

Gemeinsam kamen wir in gute Energie und der Flow ([4]) ließ nicht lange auf sich warten. Die Zeit verging wie im Flug.
So zogen sich unsere Video-Meetings meist so lange hin, bis eine Person von uns beiden Hunger bekam.

Alles in allem hatten wir viel Spass und ein gutes Gewissen, den Job unter den gegebenen Bedingungen so gut abgeliefert zu haben.

Persönliches Fazit

Paar-Dokumentation

  • ist produktiv
  • verbessert die Qualität der Dokumentation
  • sorgt für Wissens-Weitergabe
  • macht Spaß
  • funktioniert auch im Homeoffice

Gemeinsame Planung ist hilfreich, um den Fokus zu halten und in jeder Phase Wichtiges von Unwichtigem zu unterscheiden.

Referenzen

Der Inhalt dieser Webseite ist mein persönliches Informationsangebot. Ich übernehme keinerlei Verantwortung für hier verlinkte Inhalte anderer WWW-Seiten und sonstiger Materialien

Tagged with: , , , ,
Posted in IT allgemein, Organisationsentwicklung, Wissen

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: