Agiles Manifest
Lesedauer: 22 Minuten Technische Dokumentation in der Softwareentwicklung ist der Oberbegriff für alle schriftlichen Dokumente und Materialien, die sich mit der Entwicklung von Softwareprodukten befassen. Alle Softwareentwicklungsprodukte, ob sie nun von einem kleinen Team oder einem großen Unternehmen erstellt werden, erfordern eine entsprechende Dokumentation. Und während des gesamten Softwareentwicklungszyklus (SDLC) werden verschiedene Arten von Dokumenten erstellt. Die Dokumentation dient dazu, die Produktfunktionalität zu erklären, projektbezogene Informationen zu vereinheitlichen und die Diskussion aller wichtigen Fragen zwischen den Beteiligten und den Entwicklern zu ermöglichen.
Darüber hinaus können Fehler in der Dokumentation dazu führen, dass die Vorstellungen der Beteiligten und der Ingenieure auseinanderklaffen und die vorgeschlagene Lösung nicht den Erwartungen der Beteiligten entspricht. Daher sollten Manager der Dokumentationsqualität große Aufmerksamkeit schenken.
Die Art der Dokumentation, die das Team erstellt, und ihr Umfang hängen von der gewählten Softwareentwicklungsmethode ab. Es gibt zwei Haupttypen: agil und Wasserfall. Beide sind einzigartig, was die begleitende Dokumentation angeht.
Welche Dokumentation ist für agile Projekte erforderlich?
Es gibt keine formalen Vorlagen für die Dokumentation; stattdessen werden bewährte Verfahren verwendet. In verschiedenen Phasen sind unterschiedliche Arten von Dokumenten erforderlich: Projektcharta, Visionserklärung, Geschäftsanforderungsdokument, funktionale und nicht-funktionale Anforderungen, High-Level-Design (HLD)- und Low-Level-Design (LLD)-Dokumente usw.
Führen wir bei agile eine Dokumentation durch?
Die Dokumentation ist ein wichtiger Bestandteil jedes Systems, ob agil oder nicht, aber eine umfassende Dokumentation als solche ist kein Garant für den Projekterfolg. Vielmehr erhöht sie die Wahrscheinlichkeit des Scheiterns.
Was ist ein agiler Ansatz für die Dokumentation?
Agile Dokumentation ist ein Ansatz zur Erstellung prägnanter Dokumente, die der jeweiligen Situation dienen. In traditionellen Softwareentwicklungsprojekten gibt es eine umfassende Dokumentation, die als Strategie zur Risikominderung wahrgenommen wird.
Dokumentation bewährter Verfahren
Wie Sie wissen, fordert das Agile Manifest “funktionierende Software vor umfassender Dokumentation”. Sie könnten also den Eindruck gewinnen, dass die agile Methodik jegliche Dokumentation ablehnt. Da liegen Sie falsch. Wir werden einen kurzen Überblick über die besten Praktiken der agilen Dokumentation geben.
In Agile werden einige dieser Dokumente benötigt, aber der Inhalt ist völlig anders. Wir stellen einige Grundregeln für die agile Dokumentation vor, die Ihnen helfen werden, Ihren Arbeitsaufwand zu reduzieren und Ihnen Zeit, Geld und Papierverschwendung zu ersparen.
Sie enthält in der Regel alle wichtigen Informationen über das Projekt: die Kostenschätzungen, die wichtigsten Ziele und Vorgaben, alle Vorteile, die möglichen Risiken und die Meilensteine. Erstellen Sie ihn nur dann, wenn er unbedingt benötigt wird, z. B. wenn Ihre Stakeholder ihn brauchen oder Sie Investoren anlocken müssen. Am besten ist es, wenn Sie nur die wichtigsten Punkte auflisten.
Hier finden Sie eine ausführliche Beschreibung aller verwendeten Materialien, Werkzeuge und Technologien, der Entwicklungsstufen, des Personalbestands usw. Sie wollen hier nicht das Allgemeinwissen aufführen, sondern nur das, was schwarz auf weiß stehen muss, um hervorgehoben zu werden.
Projektdokumentation
Im Manifest für Agile Softwareentwicklung wird “funktionierende Software über umfassende Dokumentation” gestellt. Dieser Kernwert fordert uns auf, darüber nachzudenken, wie viele und welche Arten von Dokumenten benötigt werden und wann sie geschrieben werden müssen.
Das Agile Manifest bevorzugt “funktionierende Software vor umfassender Dokumentation”. Warum also verbringen Designer Zeit mit Artefakten, die der Benutzer nie zu Gesicht bekommen wird? Agiles Vorgehen zielt darauf ab, Verschwendung zu minimieren, so dass, wenn man es auf die Spitze treibt, jede Dokumentation Verschwendung ist. Das bedeutet nicht, dass die Dokumentation ganz abgeschafft werden kann (oder sollte); sie ist notwendig, damit Teams funktionieren (insbesondere in großem Umfang). Aber es bedeutet, dass die Minimierung der Dokumentation eine gute Sache ist und dass Designer versuchen sollten, Designentscheidungen mit so wenig Aufwand wie möglich zu kommunizieren.
Das Ziel bei Agile sollte sein, das richtige Gleichgewicht zwischen Dokumentation und Diskussion zu finden. Dokumentation ist ein wichtiger Bestandteil jedes Systems, ob agil oder nicht, aber eine umfassende Dokumentation als solche ist kein Garant für den Projekterfolg. Vielmehr erhöht sie die Wahrscheinlichkeit des Scheiterns.
Dokumentation in Scrum
Im Manifest für Agile Softwareentwicklung wird “funktionierende Software über umfassende Dokumentation” gestellt. Dieser Kernwert fordert uns auf, darüber nachzudenken, wie viele und welche Arten von Dokumenten benötigt werden und wann sie geschrieben werden müssen.
Das Agile Manifest bevorzugt “funktionierende Software vor umfassender Dokumentation”. Warum also verbringen Designer Zeit mit Artefakten, die der Benutzer nie zu Gesicht bekommen wird? Agiles Vorgehen zielt darauf ab, Verschwendung zu minimieren, so dass, wenn man es auf die Spitze treibt, jede Dokumentation Verschwendung ist. Das bedeutet nicht, dass die Dokumentation ganz abgeschafft werden kann (oder sollte); sie ist notwendig, damit Teams funktionieren (insbesondere in großem Umfang). Aber es bedeutet, dass die Minimierung der Dokumentation eine gute Sache ist und dass Designer versuchen sollten, Designentscheidungen mit so wenig Aufwand wie möglich zu kommunizieren.
Das Ziel bei Agile sollte sein, das richtige Gleichgewicht zwischen Dokumentation und Diskussion zu finden. Dokumentation ist ein wichtiger Bestandteil jedes Systems, ob agil oder nicht, aber eine umfassende Dokumentation als solche ist kein Garant für den Projekterfolg. Vielmehr erhöht sie die Wahrscheinlichkeit des Scheiterns.