02. 設計仕様ポータル¶
アーキテクチャ、データモデリング、API設計など、構成設計に関わる資料のナビゲーションハブです。新旧システムの差分や意思決定履歴を素早く辿れるように整理しています。
🔑 主要導線¶
| 🎯 ゴール | 🔗 ドキュメント | 📝 補足 |
|---|---|---|
| システム全体像を把握する | architecture/ | ネットワーク構成、ホスティング比較、冗長化方針 |
| UI指針を確認する | storefront-style-guide.md | Next.js Storefrontのデザイン原則 |
| 旧ロジックの継承範囲を知る | legacy-pricing-algorithm.md | price_chk() 関数の詳細と移行ポイント |
🧱 セクション別カード¶
アーキテクチャ (architecture/)¶
| 🔗 ドキュメント | 内容 | 目的 |
|---|---|---|
| hosting-platform-selection.md | Fly.io, Railway, Render 等の比較 | プラットフォーム選定統合資料とリンクして意思決定を追跡 |
| platform-comparison-detailed.md | 技術・コスト観点の比較表 | 仲介者向け説明資料への参照元 |
データベース設計 (database/)¶
- モジュール別のER図、テーブル定義書、インデックス戦略を格納
- Vendure標準スキーマと拡張テーブルの差分を明記する
API設計 (api/)¶
| カテゴリ | 主な内容 |
|---|---|
| GraphQL | スキーマ、カスタムフィールド、アクセス制御 |
| REST | 外部連携用エンドポイント、レート制限ポリシー |
| 認証/認可 | SSO、管理者ロール、APIキー運用 |
🧭 ドキュメント更新のヒント¶
- 設計資料は実装仕様(
03-implementation/)との整合性を常に確認する。 - 技術プラットフォームの議論は、重複を避けつつ
/docs/プラットフォーム選定統合資料.mdに一本化する。 - 旧システム資料を参照する場合は、用途(移行検証、リスク洗い出し等)を明記する。
✅ チェックリスト¶
- 新規資料追加時にナビゲーションへのリンクをこのポータルに追記した。
- 技術選定や比較表は統合資料に重複させず、参照リンクで連携した。
- 更新内容を共有するためのレビューログ(更新者・日付・概要)を各ドキュメント先頭に追記した。