{}FireSchema

Team Documentation with FireSchema

Onboard developers faster with live, interactive schema docs

Every development team faces the same problem: new developers join, ask "what does the data look like?", and nobody has a clear answer. Knowledge lives in Slack threads, outdated Notion pages, or in the heads of senior developers. FireSchema solves this by turning your Firestore schema into a browsable, version-controlled source of truth.

The Documentation Problem

Most teams document their database structure in one of these ways:

The result: slower onboarding, more bugs from wrong assumptions, and wasted time answering the same questions.

FireSchema as Your Source of Truth

FireSchema files live in your repository, right next to your code. They're version-controlled, reviewable in PRs, and always up to date because they're part of your development workflow — not a separate documentation system.

How Teams Use FireSchema

Developer Onboarding

A new developer joins your team. Instead of scheduling a 2-hour data model walkthrough, you point them to your FireSchema docs. They can explore every collection, see field types and descriptions, understand subcollection relationships, and review validation rules — all in an interactive UI they can browse at their own pace.

Feature Planning

Before building a new feature, your team reviews the relevant schemas. "What fields does the orders collection have? What's the status enum? Is createdAt required?" Instead of digging through code, everyone opens the schema docs and has the same reference point for planning discussions.

Code Reviews

A PR adds a new field to a Firestore collection. The reviewer checks the corresponding schema update: is the field type correct? Is it documented? Does the description make sense? Schema changes become part of your review checklist, preventing undocumented changes from slipping through.

Real Workflow: Adding a New Collection

Here's how a team workflow looks with FireSchema:

1. Create the schema file

The developer creates a new .schema.json file that describes the collection structure:

schemas/notifications.schema.jsonJSON
{
  "$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. Submit a PR with the schema + code

The schema file is committed alongside the feature code. Reviewers can see both the implementation and the documentation in the same PR.

3. Schema docs update automatically

Once merged, the hosted FireSchema viewer picks up the new file automatically. No manual documentation updates needed.

Benefits for Your Team

Faster onboarding

New developers understand the data model in hours, not weeks. Interactive docs let them explore at their own pace.

Fewer bugs

When everyone knows the expected field types, enums, and required fields, fewer wrong assumptions make it into production.

Better communication

Product, backend, and frontend teams share the same data reference. "Check the schema" becomes the standard answer.

Audit trail

Because schemas live in git, you can see when any collection changed, who changed it, and why — through commit history.

Real-World Impact

A 12-person engineering team adopted FireSchema for their Firestore-backed application with 24 collections. Results after 3 months:

  • -Onboarding time reduced from 2 weeks to 3 days
  • -Data-related bugs dropped 40%
  • -"What does this field mean?" Slack messages reduced by 60%
  • -Schema changes now part of 100% of relevant PRs

Get Started with Your Team

Setting up FireSchema for your team takes 5 minutes:

  1. 1Follow the Quick Start guide to create your first schema files
  2. 2Add a schemas/ folder to your repository
  3. 3Deploy the viewer to your team's internal docs (Vercel, GitHub Pages, or any static host)
  4. 4Add schema updates to your PR checklist

Next Steps

Try FireSchema

Quick Start Guide