Auto-Dokumentation
Automatisch generierte API-Spezifikationen, Domain-Modelle und Architecture Decision Records.
XAIO generiert umfassende Dokumentation parallel zu deinem Code — nicht als Nachgedanke, sondern als integraler Teil des Entwicklungsprozesses. Jedes Projekt enthält OpenAPI-Spezifikationen für APIs, JSON-Schemata für Datenmodelle und Architecture Decision Records (ADRs).
Was XAIO dokumentiert
OpenAPI-Spezifikationen
Jede generierte API enthält eine vollständige OpenAPI 3.0 Spezifikation mit Request/Response-Schemata, Authentifizierungs-Anforderungen, Fehlercodes und Beispiel-Payloads.
Domain-Modell-Dokumentation
Datenbank-Schemata, Entity-Beziehungen und Geschäftslogik-Regeln werden mit klaren Beschreibungen dokumentiert. Generierte ERD-Dokumentation zeigt Datenflüsse in deinem System.
Architecture Decision Records
Wichtige architektonische Entscheidungen werden als ADRs erfasst - warum eine bestimmte Datenbank gewählt wurde, welche Trade-offs berücksichtigt wurden. Unschätzbar für Onboarding und Wartung.
Dokumentation, die nicht veraltet
API-Dokumentation wird aus dem Code selbst abgeleitet und bei jedem Release neu gebaut — sie veraltet nicht. Domänenmodelle und ADRs werden mit dem Projekt versioniert.
Automatisch aktuell
Die API-Dokumentation wird aus dem Code selbst abgeleitet: Jedes generierte Backend bringt seine OpenAPI-Spezifikation mit, und die Spec wird bei jedem Release neu gebaut — sie kann also nicht von der Realität abweichen. Die generierte Spec speist sogar die API-Prüfungen im Code-Review-Gate vor dem Release. Domänenmodelle und Architecture Decision Records entstehen im Spezifikations-Workflow des Platform Builder und werden mit deinem Projekt versioniert.
Häufige Fragen
Was dokumentiert XAIO automatisch?
API-Spezifikationen (OpenAPI), Domänenmodelle und Architecture Decision Records — generiert parallel zum Build statt nachträglich geschrieben.
Bleiben die Docs aktuell?
API-Specs werden aus dem Code abgeleitet und bei jedem Release neu gebaut — sie können nicht veralten. Domänenmodelle und ADRs werden mit dem Projekt versioniert.