Skip to content

DESIGN.md

Diese Datei ist der Design-Einstiegspunkt. Halten Sie sie kurz und verwenden Sie sie, um zu den detaillierteren Dateien unter docs/design-docs/ zu routen.

Zweck

Dauerhafte Produkt- und Systemdesignentscheidungen dokumentieren, die einen einzelnen Chat, Sprint oder die Erinnerung eines Reviewers überdauern sollten.

Lesen Sie dies, wenn

  • Sie die aktuelle Designphilosophie benötigen
  • Sie dabei sind, ein neues Muster einzuführen
  • Sie wissen müssen, welche Designentscheidungen endgültig sind und welche noch offen sind

Kanonische Design-Dokumente

  • docs/design-docs/index.md: Index der akzeptierten, vorgeschlagenen und veralteten Dokumente
  • docs/design-docs/core-beliefs.md: projektweite Agenten-first-Überzeugungen

Designregeln

  • Halten Sie Design-Dokumente klein und aktuell.
  • Bevorzugen Sie ein Dokument pro Entscheidungsbereich.
  • Verknüpfen Sie Design-Dokumente aus Plänen und Spezifikationen, wenn eine Änderung von ihnen abhängt.
  • Wenn eine Designregel operationell kritisch wird, zu einer automatisierten Prüfung befördern oder ARCHITECTURE.md aktualisieren.