ESW-Dokumentation¶
Projektweite technische Dokumentation
Diese Dokumentation ist die zentrale, versionierte Wissensbasis des ESW-Projekts. Sie beschreibt Architektur, Entscheidungen, Governance, Betriebsverfahren, Sicherheitsvorgaben, Diagramme und organisatorische Grundlagen in einer einheitlichen, nachvollziehbaren und dauerhaft pflegbaren Form.
Bereiche¶
Architektur
Systemüberblick, Leitbild, Kontext, Container, Komponenten und Laufzeitverhalten.
Architekturentscheidungen
Nachvollziehbare technische Entscheidungen im ADR-Format mit Begründung und Kontext.
Governance
Regeln, Leitsätze, Mitwirkungsmodell und gemeinsamer Qualitätsrahmen des Projekts.
Projekt
Mitarbeit, FAQ, Sicherheitsmeldungen und projektbezogene Arbeitsgrundlagen.
Runbooks
Deployment, Backup, Wiederherstellung, Monitoring und betriebliche Routinen.
Diagramme
Strukturen, technische Modelle und schematische Darstellungen als ergänzende Referenz.
Rechtliches
Lizenzrichtlinien, Hinweise zu Fremdkomponenten und projektbezogene Rechtsgrundlagen.
Organisation
Zuständigkeiten, Strukturen, Rollenbilder und organisatorische Einordnung des Projekts.
Einstieg¶
Neue Mitwirkende beginnen in der Regel mit den Bereichen Projekt, Governance und Architektur.
Für Betrieb, Deployment und Störungsbehandlung sind vor allem die Runbooks relevant.
Technische Entscheidungen mit dauerhafter Tragweite werden in den Architekturentscheidungen dokumentiert.
Grundsätze dieser Dokumentation¶
- Änderungen erfolgen versioniert und nachvollziehbar.
- Architektur, Betrieb und Projektorganisation werden gemeinsam betrachtet.
- Dauerhaft relevante Entscheidungen werden schriftlich begründet.
- Dokumentation ist Teil der Entwicklungsarbeit und kein nachgelagertes Nebenprodukt.
Repository¶
Die Inhalte dieser Seite werden im Repository esw-docs gepflegt und automatisiert als statische Doku-Site veröffentlicht.