Agile Dokumentation

Die Dos and Dont's der agilen Dokumentation

Lesedauer: etwa 9 Min.

Während Teams ihre Arbeitsweisen in den letzten zwei Jahrzehnten vom Wasserfallmodell zu agilen Methoden verlagert haben, hat sich ein negatives Stigma um die Dokumentation gebildet. 

Viele Teams legen die Erklärung des agilen Manifests hinsichtlich „Funktionierende Software vor umfassender Dokumentation“ falsch aus und meinen damit „keine Dokumentation“. Es stimmt zwar, dass herkömmliche Ansätze zur Dokumentation ineffizient sind, aber die vollständige Beseitigung der Dokumentation kann für agile Teams schädlich sein, insbesondere da Remote- und Hybridarbeit immer häufiger werden. 

Ziehen wir als Beispiel den Versuch, ein Haus zu bauen, heran. Es spielt keine Rolle, wie schnell, schrittweise und effizient man dabei ist: Ohne Rohbau und Fundament wird das Haus nicht lange stehen bleiben. In ähnlicher Weise bietet die Dokumentation agilen Teams die notwendige Grundlage, um zu lernen, sich anzupassen, Innovationen zu entwickeln und Kunden einen Mehrwert zu bieten. Ohne sie sind agile Teams falsch ausgerichtet, anfällig für Fehler und Missverständnisse, ineffizient und verfügen nicht über den nötigen Kontext, um Entscheidungen zu treffen und sich an Marktveränderungen anzupassen. 

In anderen Worten: Während die Eliminierung der Dokumentation wie eine Möglichkeit erscheint, die Agilität vorübergehend zu erhöhen, verringert sie die Agilität auf lange Sicht erheblich.

Anstatt die Dokumentation ganz abzuschaffen, haben die Teams die Möglichkeit, die Dokumentation besser zu gestalten. Die Lösung liegt nicht darin, zu der Art und Weise der Handhabung der Dokumentation aus Tagen des Wasserfallmodells zurückzukehren; die Teams müssen eine agile Dokumentation annehmen, die organisch, lebendig, anpassungsfähig und sehr visuell ist.

Wie sieht ein agiler Dokumentationsansatz aus?

Ein agiler Dokumentationsansatz folgt vielen der gleichen Prinzipien wie das Agile Manifest selbst. Das heißt, es sollte iterativ, anpassungsfähig und kollaborativ sein. Eine effektive agile Dokumentation hat folgende Ziele:

  • Bessere gemeinsame Nutzung des Kontextes zwischen hybriden Teams und Eliminierung von unnötigem Hin und Her
  • Teams wird eine schnellere Markteinführung ermöglicht, indem wiederholbare Prozesse als Vorlage gestaltet werden
  • Effizientes Onboarding-Erlebnis für neue Mitarbeitende

Angesichts der zunehmenden Komplexität von Unternehmen – mehr Software, mehr Daten, beschleunigte Änderungen und die zunehmende Einführung von verteilter Arbeit – können sie es sich nicht leisten, auf Dokumentation zu verzichten; sie ist eine Notwendigkeit für effiziente Arbeit und kontinuierliche Verbesserungen.

In Zeiten knapper werdender Budgets, der Fluktuation von Mitarbeitenden und anderer Bedrohungen für das Unternehmen hilft eine bessere Dokumentation zu verhindern, dass wertvolles Wissen in Ihrem Unternehmen versickert.

Was sind einige Beispiele für agile Dokumentation? 

Agile Dokumentation umfasst Dokumente, Diagramme oder Vorlagen, die einfach zu verstehen und sehr visuell sind und den Teams helfen, Entscheidungen zu treffen und voranzukommen. Dazu gehören:

Diese Dokumente sind zwar wichtig, um die Teams aufeinander abzustimmen, aber es gibt auch weniger formelle Wege, Informationen zu dokumentieren, die für kontinuierliche Innovation ebenso wichtig sind.

Wenn Sie beispielsweise Ihre Agile Events remote hosten, nutzen Sie einen virtuellen Teamraum, um Ideen, Hindernisse oder Feedback zu erfassen. Dieser virtuelle Raum dient als eine Form der lebendigen Dokumentation, in welcher der Projektkontext und die Entscheidungen aufgezeichnet werden.

Scrum-Teamraum für mehrere Räume
Scrum Vorlage für Teamräume und für mehrere Räume (klicken Sie auf das Bild, um es online zu bearbeiten)

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.

Vorlage für Nutzerforschung und Journey Mapping
Vorlage für Benutzerrecherche und Journey-Mapping (klicken Sie auf das Bild, um es online zu bearbeiten)

Eines der größten Probleme bei der Dokumentation ist die Häufigkeit, mit der sie aktualisiert werden muss und wie viel Kommunikations- und Verteilungsarbeit geleistet werden muss, um sicherzustellen, dass jeder Kenntnis von der Verfügbarkeit einer neuen Version hat.

Eine Speicheroption in der Cloud – vorzugsweise eine, die visuelle Kollaboration unterstützt, um Informationen noch verständlicher zu machen – bedeutet, dass Sie sich nicht mit Versionsproblemen herumschlagen müssen. Außerdem wird gewährleistet, dass Teammitglieder Zugang zu den notwendigen Informationen haben, um schnell und sicher Entscheidungen zu treffen.

Don't: Dokumentation als Gesprächsersatz verwenden

Während eine klare, visuelle Dokumentation asynchrones Arbeiten ermöglichen kann, sollte sie das Gespräch ergänzen, nicht ersetzen. Bei der Erstellung einer besseren Dokumentation geht es nicht darum, die Notwendigkeit der Kollaboration mit den Teamkollegen zu vernachlässigen, sondern darum, diese Verbindungen zu stärken und Gespräche zu führen, die zu bahnbrechendem Denken und Innovationen führen.

Denken Sie an dieses agile Prinzip: Die effizienteste und effektivste Methode, Informationen an und innerhalb eines Entwicklungsteams zu vermitteln, ist das persönliche Gespräch.

Do: Ansprechende und einfache visuelle Elemente verwenden

Eine Dokumentation, die vorzugsweise visuelle Darstellungen gegenüber reinem Text verwendet, hilft Ihnen, komplexe Informationen zu verdeutlichen, Beziehungen zwischen Einheiten klarer darzustellen und ist für die Beteiligten auf einen Blick leichter zu verstehen.

Stellen Sie sich vor, Sie treten einem neuen Unternehmen bei, nur um herauszufinden, dass dessen Organigramm nur als Aufzählung vorhanden ist. Es gibt keine Hierarchie oder Ebenen oder Linien, die Berichtsstrukturen aufzeigen, sondern nur eine Liste von Namen und Stellenbezeichnungen – und Sie müssen sich selbst darum bemühen, die Beziehungen zwischen den verschiedenen Personen und Teams zu verstehen.

Das ist zwar ein etwas extremes Beispiel, aber das gleiche Prinzip gilt für die Verwendung von visuellen Elementen für jede Art von Dokumentation. Klare visuelle Darstellungen ersparen dem Leser die Arbeit, komplexe Strukturen, Beziehungen und Abhängigkeiten zu verstehen, sodass er sich auf seine eigentlichen Aufgaben konzentrieren kann.

Organigramm nach Standort
Die Visualisierung von Informationen – z. B. durch ein Organigramm – hilft bei der Verdeutlichung komplexer Informationen.

Don't: Übermäßig dichte, textlastige Dokumente erstellen

In dem Bemühen, die Dokumentation gründlich zu erstellen und Ihre Gedanken zu Papier zu bringen, darf man nicht vergessen, dass Sie die Dokumentation nicht unbedingt für sich selbst schreiben. Wenn man für sich selbst anstatt für andere schreibt, neigt man dazu, wichtige Schritte zu übersehen, eklatante Informationslücken zu übersehen oder wichtige Informationen unter zu viel Text zu vergraben.

Das Problem dabei ist, dass oft ein Dokument dabei herauskommt, das für einen selbst sinnvoll ist – weil man über Fachwissen und Kontext zu dem Prozess verfügt –, das aber für jemanden, der den Prozess zum ersten Mal versucht, unklar ist.

Wenn Sie feststellen, dass die Erstellung der Dokumentation regelmäßig viel Zeit in Anspruch nimmt, könnte das daran liegen, dass Sie zu ausführlich sind. Wenn die Dokumentation so dicht ist, dass sie nicht klar ist und deswegen nicht genutzt wird, ist sie keine gute Dokumentation. Je einfacher, desto besser.

Agile Dokumentation

Erfahren Sie mehr darüber, wie wichtig es ist, die Dokumentation zu überdenken.

E-Book herunterladen

Jetzt beliebt

Zoom’s Lucidspark Zoom App integrationLucidspark und Zoom verbessert die Zusammenarbeit

Über Lucidspark

Lucidspark ist ein virtuelles Whiteboard, das Ihnen und Ihrem Team die Zusammenarbeit erleichtert. So kommen die besten Ideen zum Vorschein. Es verfügt über Haftnotizen, Tools zum Freihandzeichnen sowie eine unbegrenzte Arbeitsfläche – kurz gesagt: alles, was man zum Erfassen der nächsten durchschlagenden Idee braucht. Und es wurde speziell für die Zusammenarbeit entwickelt. Sie können sich das in etwa wie einen Experimentierkasten vorstellen, in dem Ihr Team gemeinsam in Echtzeit Ideen erörtern und Innovationen hervorbringen kann.

Präsentiert von Lucidchart, der Plattform, der Millionen Anwender weltweit vertrauen, darunter 99 % aller Fortune-500-Unternehmen.

Loslegen

  • Preise
  • Einzelperson
  • Team
  • Unternehmen
  • Vertrieb kontaktieren
DatenschutzRechtlichesCookies

© 2022 Lucid Software Inc.