Wer agil Software entwickelt, erledigt das meistens mit Softwaretools wie Jira und gitlab – Jira wird als Issue Tracker verwendet und gitlab als Sourcecode Repository. Bisweilen wird hierbei übersehen, dass gitlab eigene Workflows empfiehlt. Dieser Artikel will exemplarisch zeigen, wie gitlab Workflows sinnvoll in agile Prozesse integriert werden können, die mit Jira gemanaged werden. In einem nachfolgenden Artikel werden dann die Aspekte der Dokumentation in den Systemen ausgearbeitet.
Autor: Detlef Hüttemann
Usability Verbesserungen Dokuwiki/struct: Inline Editing und weitere Verbesserungen im sprintDoc Werkzeug
In den letzten Sprints haben wir viel Arbeit in Usability-Verbesserung unserer zentralen Werkzeuge gesteckt! So lassen sich jetzt die Daten des struct-Plugins auch inline in Aggregationen editieren, seine Schemas und Seitenzuweisungen können effizient in der gesamten Wikifarm aktualisiert werden und Links zu Jira-Issues lassen sich nun komfortabel über einen eigenen Toolbar-Button einfügen.
Empfehlungen zur Requirements-Dokumentation im Projektalltag
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
Projekt- vs. Produktdokumentation
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.
Erster Projektmeilenstein – Evaluierung des Prototypen
Nach den ersten drei Entwicklungssprints nähern wir uns nun dem ersten Meilenstein – der Evaluierung des Prototypen bei den Pilotanwendern.
Erster Projektmeilenstein – Evaluierung des Prototypen weiterlesen
(Quellcode)-Dokumentation in der Softwareentwicklung
Dokumentation zählt nicht zu den beliebtesten Tätigkeiten von Softwareentwicklern.
Während Quellcode relativ gut dokumentiert wird, findet Projekt-Dokumentation (Wartungshandbücher, Projekthandbücher, Anwenderdokumentationen) häufig nicht oder nicht ausreichend statt.
Warum ist das so? Warum ist die Quellcode Dokumentation für Entwickler vergleichsweise einfach durchführbar?
(Quellcode)-Dokumentation in der Softwareentwicklung weiterlesen
Kickoff Termin
Das sprintDoc Projekt hatte heute seinen offiziellen Kickoff Termin mit dem Projektträger DLR, dem Forschungspartner Otto-von-Guericke-Universität Magdeburg und den Pilotanwendern Thorsis Technologies aus Magdeburg und WIZMO aus Berlin. Der Kickoff fand beim Konsortialführer CosmoCode in Berlin statt.
Projektstart!
Am 1.3.2015 ist das zweijährige Forschungsprojekt sprintDoc gestartet.
Im sprintDoc Projekt wollen wir ein zentrales Problem in agilen Softwareprojekten lösen: den Mangel an brauchbarer Dokumentation.