Was macht technical-decision-record?
🤖 Ein Codex-Skill zur Aufzeichnung technischer Entscheidungen als wiederverwendbare Markdown-Entscheidungsprotokolle. 📘
Übersicht
Dieser Skill hilft Ihnen, technische Entscheidungen in einem standardisierten Format zu dokumentieren. Jede Entscheidung wird als eigenes Markdown-Dokument festgehalten, das Kontext, Optionen und die getroffene Entscheidung strukturiert darstellt.
Verwendung
- Entscheidungsprotokoll erstellen – Fordern Sie den Skill auf, einen neuen Decision Record zu erstellen.
- Vorlage ausfüllen – Der Skill fragt nach den relevanten Informationen: Kontext, Entscheidungsoptionen, Bewertungskriterien und Begründung.
- Protokoll speichern – Das generierte Markdown-Dokument kann in Ihrem Repository abgelegt und versioniert werden.
Vorteile
- Nachvollziehbarkeit – Jede Entscheidung ist mit Kontext und Begründung dokumentiert.
- Wiederverwendbarkeit – Protokolle können als Referenz für zukünftige Entscheidungen dienen.
- Kollaboration – Teammitglieder können Entscheidungen nachvollziehen und kommentieren.
- Integration – Nahtlose Einbindung in bestehende Git-Workflows.
Unterstützte Plattformen
- Codex
Funktionsweise
Der Skill generiert basierend auf Ihren Eingaben eine Markdown-Datei mit einer festgelegten Struktur (Titel, Status, Kontext, Entscheidung, Konsequenzen). Sie können die Ausgabe in Ihren Arbeitsablauf integrieren, z. B. durch Einfügen in ein docs/decisions/-Verzeichnis.
Beispiel
# Decision Record 001: Verwendung von TypeScript
**Status:** Akzeptiert
**Datum:** 2024-03-15
## Kontext
Wir benötigen eine typsichere Sprache für unser neues Frontend-Projekt.
## Optionen
- TypeScript
- JavaScript
- Flow
## Entscheidung
TypeScript, aufgrund der breiten Community-Unterstützung und Integration mit React.
## Konsequenzen
- Erhöhte Typsicherheit
- Längere Build-Zeiten
- Bessere IDE-Unterstützung
Lizenz
MIT