Die Dos and Dont's der agilen Dokumentation
Vor diesem Hintergrund finden Sie hier einige taktische Tipps, wie Sie an Ihre agile Dokumentationspraxis herangehen können:
Do: Dokumentieren Sie Ihre Arbeit kontinuierlich
Ein großer Teil der Kritik an der Dokumentation besteht darin, dass sie ein intensiver Prozess ist, der Zeit von der eigentlichen Programmier- und Produktentwicklungsarbeit abzieht. Das muss aber nicht so sein.
In einem kürzlich erschienenen InfoQ-Artikel wird ein Ansatz für eine kontinuierliche Dokumentation vorgestellt, der darauf beruht, dass die Dokumentation an den Code gekoppelt wird und die Dokumentation dann erstellt wird, „wenn es am besten ist“ – zum Beispiel unmittelbar nach einer Fehlerbehebung und nicht erst im Anschluss an ein großes Projekt. Und ein Artikel von Lucid zum Thema Innovations-Repositories schlägt einen Ansatz vor, um all die breit angelegten Brainstorming-, Planungs- und Ausführungsarbeiten, die Sie bereits durchführen, in eine „lebende Blaupause“ darüber umzuwandeln, wie Ihr Unternehmen seine besten Ideen zum Leben erweckt.
Wenn Sie die Dokumentation auf diese Weise betrachten, wird sie zu einer natürlichen Erweiterung des Prozesses der Entwicklung, Programmierung, Sicherheit, des Testens von Verkauf und des Marketingsprozesses – und nicht zu einer separaten Aufgabe, die nur widerwillig erledigt wird. Es ist auch effizienter, während der Arbeit zu dokumentieren, da Sie in der Lage sind, Prozessnotizen zu machen, während alles noch präsent ist.
Don't: Dokumentation um der Dokumentation willen erstellen
Während des gesamten Prozesses der kontinuierlichen Dokumentation ist es wichtig, sich die folgenden Fragen zu stellen, um zu vermeiden, dass eine Dokumentation um ihrer selbst willen erstellt wird:
- Was wird mit dieser Dokumentation bezweckt?
- Für wen ist dieses Dokument gedacht und wie wird es verwendet werden?
- Ist dieses Dokument bereits an anderer Stelle vorhanden?
Eine kontinuierliche Dokumentation bedeutet nicht, dass Sie redundante Arbeit leisten müssen. Vielmehr sollten Sie nach Möglichkeiten suchen, die vorhandene Dokumentation zu ergänzen und zu verbessern.
Die Behebung von Versionsproblemen, die Optimierung einer schwer auffindbaren oder schwer lesbaren Dokumentation oder das Hinzufügen von Screenshots und Diagrammen zu einer textlastigen Dokumentation sind alles wichtige Möglichkeiten, die Wissensbasis Ihres Unternehmens über die Erstellung neuer Dokumente hinaus zu beeinflussen.
Do: Suchen Sie wenn möglich nach Möglichkeiten zur Automatisierung
Durch das Hinzufügen von Datenbanken und anderen Integrationen können Fehler und Irrtümer reduziert werden, die bei einer manuellen Aktualisierung der Dokumentation auftreten können. Dies gilt insbesondere für Entity-Relationship-Diagramme (ERD) oder andere Dokumentationen, die komplexe Datenbeziehungen darstellen.
Die Automatisierung kann Ihnen auch helfen, Zeit und manuelle Arbeit zu sparen, indem wichtige Teile Ihrer Dokumentation aktualisiert werden, ohne dass Sie daran denken müssen (oder wissen, dass dies geschieht). Wenn Sie die neuesten Daten zur Hand haben, anstatt sie mühsam suchen zu müssen, können Sie besser verwertbare Erkenntnisse gewinnen und Muster aufdecken, die Sie sonst vielleicht übersehen hätten.
Don't: Mit der Dokumentation bis zum Projektende warten
Wenn man mit der Dokumentation wartet, bis ein Projekt abgeschlossen ist, besteht die Gefahr, dass Informationen vergessen werden, dass die Fehleranfälligkeit steigt und dass am Ende eines langen Sprints das Erledigen einer letzten Aufgabe eine unnötige Belastung darstellt.
Durch einen agilen Dokumentationsansatz, bei dem ein Innovations-Repository im Moment und im Laufe der Zeit, aufgebaut werden soll, wird die Dokumentation als natürlicher Teil des Projekts eingebettet – von der Ideenfindung und Planung über das Design bis zur Markteinführung – und nicht als zusätzliche Aufgabe am Ende.
Don't: Dokumente in einem Silo produzieren
Es ist ineffizient, Zeit damit zu verbringen, Dokumente einzeln zu erstellen, und nur dann Feedback zu sammeln, wenn Sie sich in einem Entwurf befinden. Wenn der Umfang Ihrer Dokumentation nicht stimmt oder wichtige Details fehlen, müssen Sie Zeit für eine größere Überarbeitung aufwenden, die absolut vermeidbar gewesen wäre.
Wenn Sie frühzeitig mit anderen diskutieren, welche Dokumentation tatsächlich benötigt wird – oder durch die gemeinsame Erarbeitung der Dokumentation selbst –, sparen Sie später Zeit und Mühe.
Do: Dokumentation gemeinsam mit dem Team erstellen
Die Dokumentation muss nicht auf den Schultern eines Einzelnen liegen, insbesondere wenn Sie Ihre Dokumentation aus Code, Brainstorming Boards, Planungskarten oder anderen Dokumenten erstellen, die Sie bereits als Team erstellt haben.
Die Einbeziehung anderer in den Prozess stellt ihr Bewusstsein und ihre Akzeptanz sicher, da es sich um einen kollaborativen Prozess handelt. Es schafft auch eine kollektive Verantwortung, um sicherzustellen, dass Ihre Organisation die Dokumentation streng einhält, was die Wichtigkeit unterstreicht, Dokumente als Team auf dem neuesten Stand zu halten. Für neuere Mitarbeiter kann die Beteiligung am Erstellungsprozess auch eine sehr gute Lernerfahrung sein.
