architecture-decision-records

Überblick

architecture-decision-records ist eine Projektmanagement-Fähigkeit, die Teams dabei unterstützt, bedeutende technische und architektonische Entscheidungen mithilfe von Architecture Decision Records (ADRs) zu dokumentieren, nachzuverfolgen und zu überprüfen. Diese Fähigkeit bietet klare Muster und Vorlagen, um den Kontext, die Begründung und die Folgen wichtiger Entscheidungen in Ihren Softwareprojekten festzuhalten. Sie ist ideal für Entwicklungsteams, technische Leiter und Projektmanager, die einen transparenten Entscheidungsprozess etablieren und eine historische Dokumentation für Onboarding und zukünftige Referenzen pflegen möchten.

Welche Probleme löst architecture-decision-records?

• Stellt sicher, dass wichtige technische Entscheidungen dokumentiert und zugänglich sind
• Hilft Teams, vergangene architektonische Entscheidungen zu überprüfen und deren Auswirkungen zu verstehen
• Unterstützt das Onboarding, indem der Kontext für getroffene Entscheidungen bereitgestellt wird
• Standardisiert den Prozess zur Erfassung und Verwaltung von ADRs

Wer sollte diese Fähigkeit nutzen?

• Teams, die bedeutende architektonische oder technologische Entscheidungen treffen
• Organisationen, die technische Dokumentation und Entscheidungs-Transparenz verbessern möchten
• Projekte, die Design-Abwägungen und Begründungen über die Zeit nachverfolgen müssen

Verwendung

Installationsschritte

1. Fügen Sie die Fähigkeit mit folgendem Befehl zu Ihrem Projekt hinzu:

   npx skills add https://github.com/wshobson/agents --skill architecture-decision-records

2. Nach der Installation lesen Sie die Datei SKILL.md für einen Überblick über den Workflow und bewährte Vorgehensweisen.

Einstieg in ADRs

• Überprüfen Sie die enthaltenen Vorlagen und Anleitungen in SKILL.md, um zu verstehen, wie Sie Ihre ADRs strukturieren.
• Verwenden Sie das Standard-ADR-Format, um festzuhalten:
  • Kontext: Warum die Entscheidung notwendig ist
  • Entscheidung: Was entschieden wurde
  • Folgen: Auswirkungen und Ergebnisse
• Speichern Sie ADRs in einem eigenen Ordner im Repository (z. B. /docs/adr/).

Anpassung des Workflows

• Passen Sie Vorlagen und Prozesse an die Bedürfnisse Ihres Teams, Ihre Tools und die Repository-Struktur an.
• Nutzen Sie den ADR-Lebenszyklus (Vorgeschlagen → Akzeptiert → Veraltet → Ersetzt), um den Status jeder Entscheidung zu verfolgen.

Wichtige Dateien zum Durchsehen

• SKILL.md – Hauptanleitung und Workflow
• README.md, AGENTS.md und unterstützende Ordner (sofern vorhanden) für zusätzlichen Kontext

FAQ

Wann sollte ich mit architecture-decision-records ein ADR schreiben?

Schreiben Sie ein ADR für jede bedeutende architektonische oder technische Entscheidung, wie die Einführung eines neuen Frameworks, die Wahl einer Datenbanktechnologie oder das Design einer API. Routinewartungen, kleinere Updates oder Fehlerbehebungen erfordern in der Regel kein ADR.

Welches Format empfiehlt architecture-decision-records?

Die Fähigkeit stellt eine Standard-ADR-Vorlage (MADR-Format) bereit, die Kontext, Entscheidung und Folgen erfasst. Sie können diese Vorlage je nach Projekt anpassen.

Wo sollte ich ADRs im Projekt speichern?

ADRs werden üblicherweise in einem eigenen Ordner wie /docs/adr/ oder /architecture/decisions/ im Repository abgelegt, um einfachen Zugriff und Versionskontrolle zu gewährleisten.

Wie unterstützt diese Fähigkeit das Projektmanagement?

Durch die Dokumentation von Entscheidungen und deren Begründungen verbessert architecture-decision-records die Transparenz, das Onboarding und die langfristige Wartbarkeit für technische Teams.

Wo finde ich weitere Details oder Vorlagen?

Öffnen Sie den Reiter "Files" im Skill-Verzeichnis, um alle verfügbaren Vorlagen, Referenzen und Hilfsskripte zu entdecken, die mit architecture-decision-records geliefert werden.