In der Softwareentwicklung sind Architecture Decision Records (ADR) ein bewährtes Mittel, um wichtige Entscheidungen festzuhalten und für alle nachvollziehbar zu machen. Dies ist vor allem dann wichtig, wenn die ursprünglichen Entscheider schon lange aus dem Unternehmen ausgeschieden sind und der Grund für deren Entscheidung nicht mehr abrufbar ist.
Doch wo und wie verwaltet man diese Dokumente am besten? Viele Teams nutzen bereits Redmine als Projektmanagement-Tool – und wissen oft nicht, dass das integrierte Wiki ideal für die Verwaltung von ADRs geeignet ist.
Warum das Redmine-Wiki?
- Alles an einem Ort Redmine ist in vielen Projektteams bereits im Einsatz. Das Wiki ist direkt integriert sodass du nur das Modul im Projekt aktivieren musst, um es zu nutzen. Alle ADRs liegen dann zentral in diesem Projektwiki und sind mit anderen Projektinformationen verknüpft.
- Einfache Strukturierung Mit dem Redmine-Wiki kannst du für jedes ADR eine eigene Seite anlegen und diese verlinken. Eine einfache Hauptseite mit einer Liste aller ADRs reicht bereits aus, um den Überblick zu behalten. Die Struktur bleibt flexibel und passt sich deinen Anforderungen an.
- Versionierung und Historie Jede Änderung an einer Wiki-Seite wird automatisch protokolliert. So siehst du immer, wer wann was geändert hat – ein entscheidender Vorteil, wenn du nachvollziehen möchtest, warum eine bestimmte Entscheidung getroffen oder später angepasst wurde.
- Kollaboration im Team Das Redmine-Wiki ermöglicht es allen Teammitgliedern, ADRs zu lesen, zu kommentieren und bei Bedarf zu aktualisieren. Durch die Rechteverwaltung kannst du steuern, wer Änderungen vornehmen darf und wer nur lesen darf.
Beispiel aus der Praxis
Ein typisches ADR im Redmine-Wiki könnte so aussehen:
## ADR-001: Warum nutzen wir Docker für die Bereitstellung? * **Status:** Akzeptiert (2025-06-01) * **Kontext:** Wir benötigen eine flexible, reproduzierbare Umgebung für unsere Microservices. * **Optionen:** Virtuelle Maschinen, Docker, Kubernetes * **Entscheidung:** Docker * **Begründung:** Docker bietet eine einfache Containerisierung, schnelle Bereitstellung und gute Integration in unsere bestehende Infrastruktur. * **Konsequenzen:** Das Team muss Docker lernen, aber langfristig profitieren wir von der Flexibilität.
Das Redmine-Wiki ist eine praktische, kostengünstige Lösung für die Verwaltung von ADRs – besonders für Teams, die Redmine bereits nutzen. Es bietet alles, was du für eine klare, nachvollziehbare und kollaborative Dokumentation brauchst: zentrale Ablage, Versionierung, einfache Bearbeitung.
Und wem das nicht ausreicht dem bietet das Redmine Wiki Guide Plugin weitere nützliche Funktionen um dich bei der Dokumentation der ADRs zu unterstützen.
Zusätzliche Funktionen durch Wiki Guide Plugin für Redmine
- Mit intelligenter LiveSearch findest Du Inhalte noch schneller als über die globale Redmine Suche.
- Regex-Operatoren in den Filtern der Wiki-Liste helfen beim gezielteren Aufspüren spezieller Informationen im Inhalt oder Titel.
- TAGs für Wiki-Seiten sorgen für eine klare Kategorisierung von ADRs.
- Mehrstufige Freigabeworkflows stellen sicher, dass nur geprüfte Inhalte veröffentlicht werden.
- Lesebestätigungen garantieren, dass wichtige Dokumente wirklich bei allen ankommen.
- Automatische Listen zeigen verwaiste oder veraltete Seiten auf.
- und noch einiges mehr…
Probier es aus und bringe mehr Transparenz in deine Architektur-Entscheidungen!
Alle Informationen zu unseren Erweiterungen für Redmine gibt es auf der Produktseite. Kunden, deren Redmine den Mindestanforderungen nicht entspricht oder die lieber jemanden für die Installation und regelmäßige Pflege ihrer Redmine-Instanz beauftragen wollen, haben alternativ die Möglichkeit unser Managed Applikation Hosting für Redmine zu buchen. Hier ist das Plugin bereits Teil unseres Hosting Angebots. Die Funktionalität kann in unserer Online-Demo ausgiebig getestet werden.