Obwohl die Dokumentation als wichtig eingeschätzt wird, ist funktionierende Software wichtiger?

Am 4. Dezember 2020 fand das Online-Breakfast zum Thema «Dokumentation im agilen Kontext» statt. Aufgrund der aktuellen Situation wurde der Anlass online als Live Event über Microsoft Teams durchgeführt. Der Einladung sind 33 Teilnehmergefolgt. Die Teilnehmer kamen aus vielen verschiedenen Branchen und hatten verschiedene Rollen (PO, BE, RE, etc.). Die Referenten teilten ihr Wissen und ihre Erfahrungen zum Thema aus diversen Perspektiven, die untenstehend beschrieben werden. Im Anschluss beantworteten sie die Fragen der Teilnehmer. Für all jene, die nicht teilnehmen konnten, wurde der Livestream aufgezeichnet. Im Folgenden werden die Inhalte kurz beschrieben. Zudem finden Sie dort die Referenzen zum Livestream, der bei Infometis bestellt werden kann.

Milica Trajkovic
Business Solutioneer

Einer der vier Werte im Agilen Manifest beschreibt, dass funktionierende Software mehr geschätzt wird als eine umfassende Dokumentation. Beide Extrempositionen (Keine Dokumentation vs. alle Informationen in der Dokumentation) sind jedoch nicht hilfreich, weil das Ziel das Verständnis der Materie weiterzugeben nicht erfüllt wird. Deshalb empfiehlt sich der Ansatz, die Dokumentation als Mittel zum Zweckeinzusetzen und anderen Kommunikationskanälen gegenüberzustellen, wie zum Beispiel der direkten Kommunikation. Die direkte Kommunikation geniesst vor allem im agilen Zeitalter einen hohen Stellenwert und dank kurzen Frage-Antwort-Zyklen lassen sich Anforderungen klarer und schneller definieren oder umsetzen. Daher braucht es in dieser Phase, wo die Anforderungen regediskutiert werden, keine ausführliche Dokumentation.

Die Ansätze zur Dokumentation im agilen Kontextlauten: Die Dokumentation soll …
– bedarfsgerecht und unkompliziert sein
– gerade das Nötigste an Details beinhalten.
– «Just in Time» erstellt werden, damit keine veralteten Informationen dokumentiert sind.
– wenn möglich aus Workshops, Zeichnungen und Diagrammen wiederverwendet.
– für die Zielgruppe einfach zugänglich sein.
– kollaborativ im Team entwickelt werden.

Referenz zum Livestream
Einleitung ab 00:08:39 bis 00:20:16
Dokumentation im agilen Zeitalter von 00:12:16 bis 00:20:25

‍

Dr. Patrick Steiger
Business Solutioneer

Das vorherige Thema zum Zweckaufgreifend wurden die Settings (Kontext) und die Arten von Dokumentation vorgestellt. Zudem wurde auf die Frage eingegangen, für wen wir dokumentieren. Bei der Analyse des Kontextes wird die Kommunikation und Zusammenarbeit, die Maturität des agilen Entwicklungsteams, der Organisationsansatz, die Branche und Art der Entwicklung beurteilt. Es gibt verschiedene Dokumentation sarten, die es klar zu unterscheiden gibt. Auf der obersten Ebene wird zwischen nachhaltiger Produktdokumentation und kurzfristigen Anforderungsdokumentation unterschieden. Die nachhaltige Produktdokumentation beschreibt die Fach-, die Technische- und die Testdokumentation. Die temporäre Anforderungsdokumentation wird in Projektdokumentation und Umsetzungsinhalte gegliedert.  Die Frage, für wen wir dokumentieren, wurde bezüglich der Produktdokumentation so beantwortet: Für uns selbst, für die Weiterentwicklung, für den Benutzer, für den Betrieb und die Revision. Dieselbe Frage bezüglich der Anforderungsdokumentation ist wie folgt zu beantworten: Für das ganze Projektteam, den Product Owner, den Auftraggeber, die Lieferanten und andere Teams sowie die Stakeholder im Allgemeinen.

Referenz zum Livestream
Welche Dokumentation in welchem Setting?
von 00:20:37 bis 00:38:19

‍

Bernhards Fuchs
Automation Genius

Danach wurde die Dokumentation aus der Perspektive eines Testers beleuchtet und anhand von Praxisbeispielen aufgezeigt. Für das Testing ist die Dokumentation ein wichtiger Bestandteil der Arbeit und soll kurzgefasst und graphisch sein, relevante Inhalte wie z.B. das erwartete Ergebnis und Testdaten beinhalten. Wichtig ist, dass sie rechtzeitig erfolgt. Bei einer ungenügenden Dokumentation ist die Auswirkung auf die Projekteinführung gross, weil die Nachfragen bei Unklarheiten zu zusätzlichem Zeitaufwand führen und das Testen umständlicher machen. Erschwerend kann bei ungenügender Dokumentation hinzukommen, dass manche Ansprechpersonen oft schwierig zu erreichen sind. In Bezug auf die Dokumentationsarten wird aus Testing-Sicht vor allem aufs konzeptuelle Testdesign und die Regressionstestfälle für die nachhaltige Dokumentation verwiesen. Bei der Anforderungsdokumentation sind es die Testkonzepte und -daten sowie geeignete Fehler- und Testberichte. Um das Testobjekt besser zu verstehen, sind Visualisierungen oder eine User Story Map nützlich.

Referenz zum Livestream
Agile Dokumentation aus Sicht des Testens
von 00:38:20 bis 00:54:00

‍

‍Anja Zhuchkova
Atlassian Consultant  

Die Tools aus der Atlassian-Palette bieten ein hohes Mass an Unterstützung bei der agilen Dokumentation. Am meisten Werkzeuge bietet Confluence an, da dieses Tool von Anfang an das Ziel hatte, die Dokumentation zu vereinfachen und somit mehr Zeit für die Entwicklung zu schaffen. Folgende integrierte Features sind aus unserer Sicht essentiell, um Mitarbeitenden die Dokumentation zu erleichtern:
– Vordefinierte «best-practice» sowie individuelle Vorlagen
– Gleichzeitige Bearbeitung und Versionierung der Seiten
– Bidirektionale Verbindung mit Jira
– Schnelles Feedback durch Inline Kommentare und Benachrichtigungen
– Einfaches Berechtigungsmanagement
– Diverse Erweiterungen und Integrationsmöglichkeiten (Office-Integration, Diagramme, Videos, etc.)
– Ortsunabhängiger Zugriff via Webbrowser und Mobile App

Neben Confluence bietet auch Jira wichtige Hilfsmittel, welche die direkte Kommunikation sowie Produkt- und Projektdokumentation unterstützen. Dazu gehören unter anderen Benachrichtigungen, Kommentare, Testmanagement-Integrationen und diverse Features für die agilen Zeremonien.

Referenz zum Livestream
Tools zur Unterstützung der agilen Dokumentation
von 00:54:06 bis 01:09:00
Q&A Session ab 01:10:00

‍

Wie zu lesen ist, wurde das komplexe Thema der Dokumentation aus verschiedenen Perspektiven und mit grossem Expertenwissen vorgestellt.

Benötigen Sie Unterstützung, um eine Dokumentationsstrategie zu entwickeln? Gerne können Sie sich an Dr. Patrick Steiger oder Milica Trajkovic wenden. Wir offerieren einen Firmenkurs, der auf Ihren Kontext zugeschnitten wird, und werden anhand von Workshops die für Sie passende Strategie erarbeiten.

Nachfolgend einige Einblicke, wie es hinter den Kulissen zu diesem Teams Live Event aussah: