Wie diese Dokumentation organisiert ist
Diese Dokumentation ist mit dem Diátaxis-Framework organisiert. Diátaxis stellt fest, dass technische Dokumentation vier verschiedene Bedürfnisse bedient und dass ihre Vermischung die Docs für alle schlechter macht. Deshalb steht oben in der Seitenleiste vier Modi, keine Liste von Produktfunktionen:
| Modus | Ausrichtung | Beantwortet | Wenn Sie… |
|---|---|---|---|
| Tutorials | Lernen | ”Bring mich von Null zu einem funktionierenden Ergebnis.” | neu sind und durch Tun lernen wollen |
| How-to-Guides | eine Aufgabe | ”Wie erledige ich diese konkrete Sache?“ | arbeiten und ein Rezept brauchen |
| Referenz | Information | ”Was genau sind API, Events, Module, Flags?“ | dagegen bauen und Präzision brauchen |
| Erläuterung | Verständnis | ”Warum ist es so gebaut?“ | evaluieren und die Begründung wollen |
Eine schnelle Übersicht, wo die Dinge liegen:
- Tutorials — die Lernpfade: von Null zu einem Read/Write-Zugriffsgraphen und der Einstieg pro realem Szenario — Single Node, Docker Compose, Kubernetes, air-gapped.
- How-to-Guides — installieren & betreiben (Self-Host, Backup & Restore, Monitoring, Troubleshooting), die Guides pro Connector (pgAudit, CloudTrail, eBPF, Claude Code, MCP, Identität) und das Cookbook der Governance-Rezepte (Deny-closed-Policies, Budgets, Genehmigungen, Drift-Triage, der Kill Switch, SIEM-Push).
- Referenz — die REST-API (gerendert aus dem eigenen OpenAPI-3.1-Vertrag des Produkts), die API-Stabilitätsrichtlinie, der Event-Bus (ein AsyncAPI-3.0-Vertrag), der Modulkatalog, die CLI und die Konfiguration.
- Erläuterung — die Architektur, das Sicherheitsmodell und das Threat Model, die Open-Core-Lizenzierung.
Konventionen
Abschnitt betitelt „Konventionen“- Die Suche ist lokal und clientseitig (Pagefind). Sie läuft vollständig in Ihrem Browser; nichts wird an einen externen Suchdienst gesendet — im Einklang mit dem self-hosted Design des Produkts, bei dem Sie bestimmen, was Ihren Perimeter überschreitet.
- Versioniert. Die Dokumentation ist versioniert: Wenn eine neue Produktversion erscheint, wird die Dokumentation der vorherigen bewahrt. Der Versionsumschalter befindet sich in der oberen Leiste.
- Ehrlich über Grenzen. Wo eine Fähigkeit im Design-Stadium, post-v1 oder schlicht noch nicht gebaut ist, sagen die Docs das unverblümt. Siehe Ehrlichkeit & Grenzen. Tutorial- und How-to-Befehle sind so gemeint, dass sie wie geschrieben ausgeführt werden.
- Sprachen. Die kanonische Dokumentation ist auf Englisch; Übersetzungen sind in Spanisch, Vereinfachtem Chinesisch, Russisch, Japanisch, Deutsch und Französisch verfügbar (maschinell übersetzt, Englisch ist maßgeblich, mit Rückfall auf Englisch für noch nicht übersetzte Seiten).