Montag, 9. Januar 2012

Mehr Urlaub = bessere Dokumentation

Kennen Sie die Situation? Sie fahren am nächsten Tag in den Urlaub und wollen noch die wichtigsten Dinge an Ihre Kollegen übergeben. Sie schreiben ein paar E-Mails an unterschiedliche Leute und erklären, wo bei Rückfragen welche Dokumente zu finden sind, warum sich der Preis für Produkt X nochmal geändert hat und welche Schritte Sie im Vorgang Y schon erledigt haben und welche noch zu tun sind.

Der letzte Tag vor dem Urlaub ist für Dokumentation eine ideale Situation:
  • Sie schreiben kurze Dokumente. (Wer liest gern lange Dokumente?)
  • Sie schreiben an spezifische Empfänger. (Wer liest gern Dinge, die für ihn irrelevant sind?)
  • Sie fangen mit dem Überblick an und verweisen auf die Details. (Wer liest gern weiter, wenn er den Zusammenhang nicht versteht?)
  • Sie beginnen mit den wichtigsten Dingen. (Wer liest gern unwichtige Dinge?)
Dokumentation bedeutet für mich nicht, ausführlich über alle Details zu berichten. Dokumentation enthält für mich genau die Informationen, die ich selbst oder mein Team braucht, um sich schnell genug in einen Vorgang einzuarbeiten.

Aufschreiben ist gut für die Teamarbeit. Andreas Rüping bringt es im Vorwort seines Buchs über agile Dokumentation (/1/) auf den Punkt:
"Documents can preserve knowledge within a team, and prevent the team from re-inventing things when team members leave and new people join."

Fangen Sie an, Dinge für Ihr Team und für Sie selbst aufzuschreiben. Schreiben Sie so, als hätten Sie ab morgen Urlaub. Wenn Sie die Situation oben kennen, wissen Sie ja bereits, dass Sie gut dokumentieren können.

Anmerkungen

Keine Kommentare:

Kommentar veröffentlichen