FireSchema によるチームドキュメント

すべての開発チームが同じ問題に直面します：新しい開発者が参加し、「データはどんな構造になっているの？」と尋ねますが、明確な答えを持つ人がいません。知識は Slack のスレッド、古くなった Notion ページ、またはシニア開発者の頭の中に散在しています。FireSchema は、Firestore スキーマを閲覧可能でバージョン管理された信頼できる唯一の情報源に変えることで、この問題を解決します。

ドキュメントの問題

ほとんどのチームは、以下のいずれかの方法でデータベース構造をドキュメント化しています：

• -数週間で古くなる Notion や Confluence のページ
• -誰も更新しない Markdown テーブルの README ファイル
• -属人的な知識 — シニア開発者が何度も同じデータモデルを説明する
• -ドキュメントが全くない — 開発者がコードからリバースエンジニアリングする

結果として：オンボーディングの遅延、誤った前提によるバグの増加、同じ質問への回答に費やされる無駄な時間。

FireSchema を信頼できる唯一の情報源に

FireSchema ファイルはリポジトリ内のコードのすぐ隣に存在します。バージョン管理され、PR でレビュー可能で、開発ワークフローの一部であるため常に最新です — 別のドキュメントシステムではありません。

• バージョン管理 — コードとともに git で変更を追跡
• PR レビュー可能 — スキーマの変更はコードレビューを通過
• 常に正確 — 開発者がコードを更新する際にスキーマも更新
• メンテナンス不要 — 別のドキュメントプラットフォームの管理が不要

チームでの FireSchema の活用方法

実際のワークフロー：新しいコレクションの追加

FireSchema を使用したチームワークフローは次のようになります：

{
  "$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"]
  }
}

チームへのメリット

チームでの導入方法

チームへの FireSchema のセットアップは5分で完了します：

1. 1Follow the Quick Start guide to create your first schema files
2. 2リポジトリに schemas/ フォルダを追加
3. 3チームの社内ドキュメントにビューアをデプロイ（Vercel、GitHub Pages、または任意の静的ホスト）
4. 4PR チェックリストにスキーマの更新を追加

次のステップ