Zum Hauptinhalt springen

Documentation Templates

🤖 Generated with Claude Code

⚠️ Not yet reviewed

Co-Authored-By: Claude (noreply@anthropic.com)

Standard-Vorlagen für technische Dokumentation. Alle Templates sind pures Markdown (kein MDX), damit sie in andere Repos kopiert werden können.

TemplateZweck
solution-proposal.mdLösungsvorschlag inkl. Varianten & Empfehlung
technical-design.mdTechnisches Design eines Services/Features
adr.mdArchitecture Decision Record
integration-guide.mdAnleitung für Consumer einer Schnittstelle
devops-deployment-notification.mdDeployment-Ankündigung (DevOps)
cca-release-announcement.mdCCA Release-Ankündigung
cca-release-status-update.mdCCA Release Status-Update

Verwendung​

  1. Template in das Ziel-Repo bzw. den Ziel-Ordner kopieren
  2. Platzhalter ersetzen, nicht benötigte Abschnitte löschen
  3. Diagramme in D2 gemäß Diagram Style Guide erstellen, Farben aus assets/colors/_colors.d2 importieren