Jedes Entwicklungsteam steht vor dem gleichen Problem: Neue Entwickler kommen dazu, fragen "wie sehen die Daten aus?" und niemand hat eine klare Antwort. Wissen steckt in Slack-Threads, veralteten Notion-Seiten oder in den Köpfen erfahrener Entwickler. FireSchema löst das, indem es dein Firestore-Schema in eine durchsuchbare, versionskontrollierte Quelle der Wahrheit verwandelt.
Das Dokumentationsproblem
Die meisten Teams dokumentieren ihre Datenbankstruktur auf eine dieser Weisen:
- -Notion- oder Confluence-Seiten, die innerhalb von Wochen veralten
- -README-Dateien mit Markdown-Tabellen, die niemand aktualisiert
- -Stammwissen — erfahrene Entwickler erklären das Datenmodell immer wieder
- -Gar keine Dokumentation — Entwickler erschließen sich die Struktur aus dem Code
Das Ergebnis: langsameres Onboarding, mehr Bugs durch falsche Annahmen und verschwendete Zeit für die Beantwortung immer gleicher Fragen.
FireSchema als deine Quelle der Wahrheit
FireSchema-Dateien leben in deinem Repository, direkt neben deinem Code. Sie sind versionskontrolliert, in PRs überprüfbar und immer aktuell, weil sie Teil deines Entwicklungs-Workflows sind — kein separates Dokumentationssystem.
- Versionskontrolliert — Änderungen werden in Git zusammen mit deinem Code verfolgt
- PR-überprüfbar — Schema-Änderungen durchlaufen Code-Reviews
- Immer aktuell — Entwickler aktualisieren Schemas, wenn sie Code aktualisieren
- Wartungsfrei — keine separate Dokumentationsplattform zu verwalten
Wie Teams FireSchema nutzen
Entwickler-Onboarding
Ein neuer Entwickler tritt deinem Team bei. Anstatt eine 2-stündige Datenmodell-Einführung zu planen, verweist du auf deine FireSchema-Dokumentation. Dort können sie jede Sammlung erkunden, Feldtypen und Beschreibungen sehen, Untersammlungs-Beziehungen verstehen und Validierungsregeln überprüfen — alles in einer interaktiven Oberfläche, die sie in ihrem eigenen Tempo durchsuchen können.
Feature-Planung
Bevor ein neues Feature gebaut wird, überprüft dein Team die relevanten Schemas. "Welche Felder hat die Orders-Sammlung? Was ist das Status-Enum? Ist createdAt erforderlich?" Anstatt im Code zu graben, öffnet jeder die Schema-Dokumentation und hat die gleiche Referenz für Planungsgespräche.
Code Reviews
Ein PR fügt ein neues Feld zu einer Firestore-Sammlung hinzu. Der Reviewer prüft die entsprechende Schema-Aktualisierung: Ist der Feldtyp korrekt? Ist er dokumentiert? Ergibt die Beschreibung Sinn? Schema-Änderungen werden Teil deiner Review-Checkliste und verhindern, dass undokumentierte Änderungen durchrutschen.
Realer Workflow: Eine neue Sammlung hinzufügen
So sieht ein Team-Workflow mit FireSchema aus:
1. Schema-Datei erstellen
Der Entwickler erstellt eine neue .schema.json-Datei, die die Sammlungsstruktur beschreibt:
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"collection": "notifications",
"description": "User notification preferences and history",
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Reference to the user document"
},
"type": {
"type": "string",
"enum": ["email", "push", "sms"],
"description": "Notification channel"
},
"enabled": {
"type": "boolean",
"description": "Whether this notification type is active"
}
},
"required": ["userId", "type", "enabled"]
}
}2. PR mit Schema + Code einreichen
Die Schema-Datei wird zusammen mit dem Feature-Code committet. Reviewer können sowohl die Implementierung als auch die Dokumentation im selben PR sehen.
3. Schema-Dokumentation aktualisiert sich automatisch
Nach dem Mergen erkennt der gehostete FireSchema-Viewer die neue Datei automatisch. Keine manuellen Dokumentations-Updates nötig.
Vorteile für dein Team
Schnelleres Onboarding
Neue Entwickler verstehen das Datenmodell in Stunden, nicht Wochen. Interaktive Dokumentation lässt sie in ihrem eigenen Tempo erkunden.
Weniger Bugs
Wenn alle die erwarteten Feldtypen, Enums und erforderlichen Felder kennen, gelangen weniger falsche Annahmen in die Produktion.
Bessere Kommunikation
Produkt-, Backend- und Frontend-Teams teilen die gleiche Datenreferenz. "Schau ins Schema" wird zur Standardantwort.
Nachvollziehbarkeit
Weil Schemas in Git leben, kannst du sehen, wann sich eine Sammlung geändert hat, wer sie geändert hat und warum — über die Commit-Historie.
Auswirkungen in der Praxis
Ein 12-köpfiges Engineering-Team hat FireSchema für ihre Firestore-basierte Anwendung mit 24 Sammlungen eingeführt. Ergebnisse nach 3 Monaten:
- -Onboarding-Zeit von 2 Wochen auf 3 Tage reduziert
- -Datenbezogene Bugs um 40% gesunken
- -"Was bedeutet dieses Feld?"-Slack-Nachrichten um 60% reduziert
- -Schema-Änderungen jetzt Teil von 100% der relevanten PRs
Mit deinem Team starten
FireSchema für dein Team einzurichten dauert 5 Minuten:
- 1Follow the Quick Start guide to create your first schema files
- 2Füge einen schemas/-Ordner zu deinem Repository hinzu
- 3Deploye den Viewer auf die interne Dokumentation deines Teams (Vercel, GitHub Pages oder ein beliebiger statischer Host)
- 4Füge Schema-Updates zu deiner PR-Checkliste hinzu