このドキュメントの構成
このドキュメントは Diátaxis フレームワークで構成されています。 Diátaxis は、技術文書が 4 つの異なるニーズに応えること、そしてそれらを混在させると誰にとっても ドキュメントが悪くなることを観察しています。そのため、サイドバーの最上部は製品機能のリストではなく 4 つのモードです。
| モード | 志向 | 答えるもの | あなたが…の時 |
|---|---|---|---|
| チュートリアル | 学習 | 「何もない状態から動く結果まで連れて行ってほしい。」 | 初めてで、手を動かして学びたい |
| ハウツーガイド | タスク | 「この特定のことをどうやって達成するか?」 | 作業中で、レシピが必要 |
| リファレンス | 情報 | 「API、イベント、モジュール、フラグは正確には何か?」 | これに対して構築中で、精密さが必要 |
| 解説 | 理解 | 「なぜこう作られているのか?」 | 評価中で、その理由を知りたい |
何がどこにあるかの簡単なマップ:
- チュートリアル — 学習パス: ゼロから read/write アクセスグラフまで、 および実際のシナリオごとの入門 — シングルノード、 Docker Compose、 Kubernetes、 エアギャップ。
- ハウツーガイド — インストールと運用（self-host、 バックアップとリストア、 モニタリング、 トラブルシューティング）、 コネクタ別ガイド（pgAudit、CloudTrail、eBPF、 Claude Code、MCP、アイデンティティ）、そしてガバナンスレシピの クックブック（deny-closed ポリシー、予算、承認、 ドリフトトリアージ、kill switch、SIEM プッシュ）。
- リファレンス — REST API（製品自身の OpenAPI 3.1 コントラクトから レンダリング）、API 安定性ポリシー、 イベントバス（AsyncAPI 3.0 コントラクト）、 モジュールカタログ、 CLI と構成。
- 解説 — アーキテクチャ、 セキュリティモデルと 脅威モデル、 オープンコアのライセンス。
- 検索はローカルかつクライアントサイド（Pagefind）です。完全にあなたのブラウザ内で動作し、 外部の検索サービスには何も送信されません。境界を越えるものをあなたが決める、製品の self-hosted 設計と一貫しています。
- バージョン管理。 ドキュメントはバージョン管理されています。新しい製品バージョンが 出荷されると、前のバージョンのドキュメントは保存されます。バージョンセレクターは上部バーに あります。
- 限界について誠実。 機能が設計段階、v1 以降、または単に未構築の場合、ドキュメントは はっきりそう述べます。誠実さと限界を参照してください。 チュートリアルとハウツーのコマンドは書かれたとおりに実行できることを意図しています。
- 言語。 正規のドキュメントは英語です。スペイン語、簡体字中国語、ロシア語、日本語、 ドイツ語、フランス語の翻訳が利用可能です（機械翻訳であり、英語が正典です。まだ翻訳されて いないページは英語にフォールバックします）。