Agiler Weg der Dokumentation!!!

Wenn Sie die agile Welt betreten, begrüßt Sie eine Aussage: "Machen Sie einfach genug Dokumentation". Eine ganze Weile war ich verwirrt, was wir damit wirklich meinen. Meiner Meinung nach ist "gerade genug" sehr zweideutig oder abstrakt. Man kann es nicht quantifizieren. Für einige, die an einem Entwicklungsprojekt arbeiten, macht die Erstellung von Dokumentation vielleicht nicht viel Sinn, da Sie auf der anderen Seite des Tisches Leute finden, die Ihre Fragen beantworten können, und Sie mit einer "nicht gerade ausreichenden Dokumentation" davonkommen (keine Java-Doku, keine Projektübersicht usw.). Wenn Sie jedoch in den Wartungszyklus des Projekts kommen, ist es einfach nur ätzend. Wartung bedeutet unter Umständen neue Mitarbeiter, einen langen Projektzyklus und Mitarbeiter, die das Projekt oder sogar die Organisation selbst verlassen. Was machen Sie dann? Die Leute, die zu Beginn des Projekts dabei waren, sind möglicherweise nicht mehr dabei, entweder auf Seiten des Kunden oder auf Seiten der Softwareentwickler. Ohne eine Wissensdatenbank werden neue Mitarbeiter versuchen, das Rad neu zu erfinden, sie werden den Code durchgehen (eine White Box, die idealerweise meistens eine Black Box sein sollte) oder sie werden wie Menschen aussehen, die in einen dunklen Tunnel eindringen, ohne eine Ahnung zu haben, was sie eigentlich tun sollen. Wir wissen also, dass wir eine gute Dokumentation benötigen und wir wissen auch, dass die Leute das normalerweise nicht tun wollen - einfach weil es nicht interessant genug ist. Es kann mechanisch sein und Sie sind vielleicht nicht der Magier der Worte, um eine Geschichte in genau die richtigen Worte zu fassen. Außerdem können Sie für das Schreiben einer Geschichte einen ganzen Tag oder sogar mehr brauchen. Wir wissen also, dass es notwendig ist, aber es ist ein hartes Geschäft.Auch aus der Sicht des Lesers möchte niemand 100 Seiten Dokumentation lesen. Wann immer wir etwas wissen wollen, wollen wir den kürzesten Weg gehen, und das ist, einen Projektexperten zu fragen. Und warum? Sie ist interaktiver, visueller und man kann sich sehr leicht und in kürzester Zeit in die Kommunikation einfinden. Sowohl für den Projektexperten als auch für den neuen Entwickler ist es viel schneller, als 100 Seiten zu schreiben oder zu lesen. Wir wissen also, was wir in Bezug auf die Dokumentation brauchen, aber die Frage bleibt, wie wir das machen. Die Antwort lautet: durch den Einsatz von Multimedia-Kommunikation. Es gibt eine Reihe von Low-Tech-, Low-Cost-/No-Cost-Soft-/Hardwares, die sehr viel weniger Aufwand bei der Einrichtung erfordern und mit denen sich Screen-Casts, Video-Casts und Pod-Casts schnell erstellen lassen. Die Dokumentation, für die Sie vielleicht 2-3 Tage brauchen, ist innerhalb von 15 Minuten nach der Präsentation mit Sprache und Video fertig. Wenn wir von Low-Tech sprechen, meinen wir damit implizit Software, die nichts oder nur sehr wenig kostet. Wir versuchen vielleicht nicht, eine sehr professionelle und perfekte Präsentation zu erstellen, aber eine Präsentation, die Sinn macht. Statt einer hochwertigen Videokamera, Lichtern und allem Drum und Dran brauchen Sie vielleicht nur ein paar Seiten und einen Marker sowie eine hochauflösende Kamera und ein Mikrofon. Das ist alles, was Sie brauchen. Ebenso gibt es verschiedene Open-Source-Software, die keine Kosten verursacht. Auch hier gilt: Multimedia ist nicht für jede Kommunikation geeignet. Die Kommunikation muss sehr einfach und direkt sein, damit das Publikum auch Interesse daran hat, sie zu sehen. Komplexe Inhalte, häufig geänderte Informationen, juristische/offizielle Dokumentationen sind möglicherweise keine Kandidaten für Multimedia. Dennoch ist es in vielen Fällen sinnvoll. Wenn Sie z.B. Design/Architektur erklären, können Sie viele Geschichten/Geschichten erzählen, die Teil Ihres reichen Erfahrungsschatzes sind und die in einer schriftlichen Dokumentation nicht enthalten sein können. Sie können mit dem Zeichnen eines einzelnen Kastens beginnen und ihn mit mehreren Kästen verbinden, während Sie einen Überblick geben und dann in die Details eintauchen. So ist das Ganze in 30 Minuten/einer Stunde fertig, was sonst 2-3 Tage zum Dokumentieren und einen halben Tag zum Lesen gebraucht hätte. Es muss jedoch ein Gleichgewicht zwischen schriftlicher und multimedialer Dokumentation bestehen. Eine schriftliche Dokumentation bietet Ihnen die Möglichkeit, die Dinge konkreter und auf den Punkt zu bringen. Wenn Sie wirklich tiefer eintauchen müssen, brauchen Sie sie. Zum Beispiel möchten Sie vielleicht nicht die Datenbankfelder erklären und sich diese merken. Sie müssen Teil des schriftlichen Referenzmaterials sein. Wenn es jedoch darum geht, Dinge im Allgemeinen zu erklären, Geschichten/Geschichten zu erzählen, warum wir dies/das getan haben oder die Abfolge von Schritten zu erläutern, ist eine Multimedia-Dokumentation hilfreicher. Eine schriftliche Dokumentation bietet Ihnen die Möglichkeit, den Inhalt aus naheliegenden Gründen zu indizieren. Wenn Sie eine lange Multimedia-Präsentation haben, wird es schwierig sein, den Inhalt zu indizieren. Es ist daher ratsam, kurze Präsentationen (10-15 Minuten) zu erstellen. Das ist auch gut für den Autor, denn so kann er sich besser auf die Dinge konzentrieren, als wenn er eine lange Präsentation hält. Vielleicht haben Sie hier ein Scrum-Prinzip entdeckt, das funktioniert :-). Verwenden Sie kleine Sprints und seien Sie fokussiert, anstatt ein großes Backlog für einen großen Sprint ohne jeglichen Fokus zu haben. Multimedia macht einfach Spaß. Die Menschen, die sie entwickeln und benutzen, mögen sie sehr gerne. Es ist immer wieder cool, einen Podcast, einen Screencast oder eine Videopräsentation für Leute zu erstellen, und es ist wirklich schön, solches Material durchzugehen. Meinen Sie nicht auch? Und wissen Sie was? Wir können mit einer wirklich "agilen" Vorgehensweise gerade genug dokumentieren. Keine abstrakte/vage Definition mehr. Die Kombination aus schriftlicher und multimedialer Dokumentation hilft den Menschen wirklich auf die richtige Art und Weise. P.S. Ich möchte mich für den Beitrag einiger großartiger Gespräche bedanken, die ich mit den Multimedia-Gurus Serge Beaumont und Robbert van Loghem geführt habe, bevor ich diesen Blog schreiben konnte.