每个开发团队都面临同样的问题：新开发者加入时问「数据长什么样？」,却没有人能给出清晰的答案。知识散落在 Slack 消息、过时的 Notion 页面或资深开发者的脑海中。FireSchema 通过将您的 Firestore Schema 转化为可浏览的、版本控制的权威数据源来解决这个问题。

文档难题

大多数团队通过以下方式记录数据库结构：

-Notion 或 Confluence 页面,几周内就会过时
-README 文件中的 Markdown 表格,无人更新
-口口相传 — 资深开发者反复讲解数据模型
-完全没有文档 — 开发者从代码中逆向推断

结果是：新人培训更慢、因错误假设产生更多 Bug,以及在回答重复问题上浪费时间。

FireSchema 作为权威数据源

FireSchema 文件存放在您的代码仓库中,与代码并肩。它们受版本控制、可在 PR 中审查,并且始终保持最新,因为它们是开发工作流的一部分 — 而非独立的文档系统。

版本控制 — 变更与代码一起在 git 中跟踪
PR 可审查 — Schema 变更经过代码审查
始终准确 — 开发者在更新代码时同步更新 Schema
零维护 — 无需管理独立的文档平台

团队如何使用 FireSchema

开发者入职培训

新开发者加入您的团队。无需安排 2 小时的数据模型讲解会议,您只需将他们引导到 FireSchema 文档。他们可以浏览每个集合、查看字段类型和描述、理解子集合关系并审查验证规则 — 所有这些都在一个可按自己节奏浏览的交互式界面中完成。

功能规划

在构建新功能之前,您的团队审查相关 Schema。「orders 集合有哪些字段？status 枚举是什么？createdAt 是必填的吗？」无需翻阅代码,每个人都可以打开 Schema 文档,在规划讨论中拥有相同的参考依据。

代码审查

一个 PR 向 Firestore 集合添加了新字段。审查者检查相应的 Schema 更新：字段类型是否正确？是否有文档说明？描述是否合理？Schema 变更成为审查清单的一部分,防止未记录的变更悄悄溜进去。

实际工作流：添加新集合

以下是使用 FireSchema 的团队工作流：

1. 创建 Schema 文件

开发者创建一个新的 .schema.json 文件来描述集合结构：

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. 随代码一起提交 PR

Schema 文件与功能代码一起提交。审查者可以在同一个 PR 中看到实现和文档。

3. Schema 文档自动更新

合并后,托管的 FireSchema 查看器会自动获取新文件。无需手动更新文档。

为您的团队带来的好处

更快的入职培训

新开发者在几小时内（而非几周）理解数据模型。交互式文档让他们按自己的节奏探索。

更少的 Bug

当每个人都了解预期的字段类型、枚举和必填字段时,更少的错误假设会进入生产环境。

更好的沟通

产品、后端和前端团队共享相同的数据参考。「查看 Schema」成为标准回答。

审计追踪

因为 Schema 存储在 git 中,您可以通过提交历史查看任何集合何时更改、谁更改了它以及为什么。

实际效果

一个 12 人的工程团队为其基于 Firestore 的应用（包含 24 个集合）采用了 FireSchema。3 个月后的成果：

-入职培训时间从 2 周缩短到 3 天
-数据相关 Bug 减少了 40%
-「这个字段是什么意思？」的 Slack 消息减少了 60%
-Schema 变更现在包含在 100% 的相关 PR 中

带领您的团队开始使用

为您的团队设置 FireSchema 只需 5 分钟：

1Follow the Quick Start guide to create your first schema files
2在您的代码仓库中添加 schemas/ 文件夹
3将查看器部署到团队的内部文档站点（Vercel、GitHub Pages 或任何静态托管）
4将 Schema 更新添加到您的 PR 检查清单

使用 FireSchema 进行团队文档管理