Spezifikationshandbuch

Das Spezifikationshandbuch (Specs) dokumentiert die technischen Anforderungen, Architekturentscheidungen und Abnahmekriterien für geplante Erweiterungen und Komponenten des p2d2-Systems. Es dient als verbindliche Grundlage für Implementierung, Test und Abnahme.

Abgrenzung zu anderen Handbüchern

Handbuch	Zweck
Benutzerhandbuch	Beschreibt die Bedienung der Anwendung aus Anwendersicht
Administrationshandbuch	Dokumentiert den Betrieb der bestehenden Infrastruktur
Entwicklungshandbuch	Erläutert Architektur und Workflows für Entwickler
Spezifikationshandbuch (dieses)	Definiert Anforderungen und Spezifikationen für noch nicht implementierte Komponenten

Während Administrations- und Entwicklungshandbuch den Ist-Zustand beschreiben, hält das Specs-Handbuch den Soll-Zustand künftiger Erweiterungen fest.

Aktuelle Bereiche

• CIVITAS/CORE-Plugin — Spezifikation eines Plugins zur Anbindung der CIVITAS/CORE-Plattform

Navigationsübersicht

• CIVITAS/CORE-Plugin — Übersicht
• CIVITAS/CORE-Plugin — Serveraufbau
  • Zielbild und Abgrenzung
  • VM-Sizing und Host-Ressourcen
  • Netzwerk, DNS und TLS
  • Kubernetes und Laufzeitarchitektur
  • Persistenz, Storage, Backup und Restore
  • Installationsphasen und Abnahmekriterien

Änderungsnachverfolgung

Änderungen an Spezifikationen werden über das Git-Repository versioniert. Jede Spezifikationsseite trägt einen eigenen lastUpdated-Eintrag im Frontmatter. Nach erfolgreicher Abnahme wird der Status auf reviewed gesetzt.