Schlagwort: Patterns

Innerhalb des Forschungsprojektes sprintDoc entstehen eine Dokumentationsmethode für agile Softwareprojekte und ein Prototyp für ein unterstützendes Werkzeug. Im Rahmen der Methode haben wir uns Gedanken über mögliche „Dokumentationsmuster“ gemacht. Dabei stellt sich die Frage, welche Informationen in dokumentiert werden sollten, wie die Informationen strukturiert sind und wie diese untereinander verknüpft sein sollten.

Gemeinsam mit unseren Pilotanwendern haben wir erste Dokumentationsmuster entwickelt. Unterschiedliche Rahmenbedingungen, Produkte oder Arbeitsweisen führen zu verschiedenen Anforderungen an die Dokumentation. Daher wollen wir gemeinsam mit Unternehmensvertretern Dokumentationsmuster für konkrete Anwendungsfälle erarbeiten. Aktuell planen wir im September 2016 einen entsprechenden Workshop „Dokumentationsmuster in agilen Softwareprojekten“.

Der Workshop findet am Montag, 26. September von 10:00 bis 15:00 Uhr bei der Fa. CosmoCode in Berlin statt. Nähere Informationen (inkl. Agenda) zum kostenfreien Workshop können unserem Workshopkonzept entnommen werden. Interessierte Praktiker aus agil softwareentwickelnden Unternehmen melden sich bitte per Mail bei Herrn Voigt von der Otto-von-Guericke-Universität.

Requirements sollen festlegen, was im (Software)-Projekt umgesetzt werden muss. In klassischen Projekten gibt es Requirements-Dokumentation zumeist in Form eines Pflichtenheftes; wenn nicht, muss ein Vor-Auftrag diese zumindest ansatzweise erfassen.Wobei Kunden manchmal nicht einsehen, dass diese „Akquise“-Tätigkeiten Geld kosten, weswegen man geneigt ist, auf die Erfassung der Anforderungen zu verzichten. Empfehlungen zur Requirements-Dokumentation im Projektalltag weiterlesen

Einige strukturierte Wikis – wie auch das im Projekt verwendete DokuWiki – ermöglichen die Integration strukturierter Daten. Dabei gibt es sehr unterschiedliche Anwendungsmöglichkeiten, denn mit der Verknüpfung von Wikiseiten und den darin enthaltenen Daten lassen sich verschiedenste Dokumentationsstrukturen realisieren. So lassen sich beispielsweise Projektdokumentationen mit den zugehörigen Meetings oder auch den wichtigsten Anforderungen verknüpfen.

Flexible Dokumentationsstrukturen mit dem struct-Plugin weiterlesen

Wie organisiert man die Projektdokumentation? Wann wird aus einer Projektdoku eine Produktdoku? Dieser Artikel beleuchtet wichtige Eigenschaften von Dokumentationsartefakten und will helfen, Dokumentationsvorgänge besser zu planen und zu managen.

Use Cases für Dokumentation

Für die Nutzung der erstellten Dokumentation gibt es viele Use Cases:

• Rückgriff auf Entscheidungen: Wer hat welche Designentscheidung zu verantworten?
• Identifikation von Detaillösungen: Wie funktioniert eine Systemkomponente im Detail?
• Beschreibung von Wartungsvorgängen: Was ist im Betrieb zu beachten?
• Testdokumentation: Wie kann eine Komponente getestet werden, wenn zB Weiterentwicklungen geplant sind?

Die oben stehenden Beispiele zeigen, dass unterschiedliche Kontexte für die Dokumentationsnutzung vorstellbar sind: Der Projektkontext („wer hat warum etwas entschieden“), der Produktkontext („wie verhält sich ein Systembaustein“).

Diese Unterscheidung ist deswegen so wichtig, weil die Dokumentation meistens während der Softwareentwicklung, also im Projektkontext erfolgt. Während der Entwicklung ist die Wahrnehmung eines Entwicklers in der Regel sehr fokussiert auf aktuelle Stories – bestensfalls ausdehnbar auf den aktuellen Sprint. Ist bei der Dokumentation vorwiegend eine Projektdokumentation zu erstellen, so schadet dieser Fokus nicht. Wenn aber eine Produktdokumentation zu erstellen ist, so interessiert nicht, warum, und wann etwas entwickelt (oder zum wiederholten male geändert wurde), sondern es gilt den Status Quo des Produktes in der Dokumentation nachzuziehen.

Projekt- vs. Produktdokumentation weiterlesen