backend-design-review

バックエンド設計レビュー

レビューワークフロー

以下の体系的なレビュープロセスに従います。

1. レビュー前の準備

• 設計ドキュメントを収集します（アーキテクチャ図、API 仕様、データベーススキーマ、ADR）
• 要件を把握します（機能要件、非機能要件、コンプライアンス）
• レビューの範囲と優先順位を定義します
• 制約事項を特定します（テクノロジー、予算、スケジュール）

2. API 設計レビュー

• RESTful なリソースモデリング、HTTP メソッドの使用、ステータスコードを評価します
• GraphQL スキーマ設計、型定義、クエリパターンをレビューします
• gRPC のサービス定義と Protocol Buffers スキーマを評価します
• API のバージョニング戦略とドキュメントを検証します
• 認証、認可、セキュリティ対策を確認します

3. データベース設計の検証

• データモデリング、エンティティ間の関係、正規化をレビューします
• スキーマ設計、カラム型、制約、インデックスを評価します
• クエリパターンと N+1 クエリの防止策を評価します
• データ整合性ルールと参照整合性を確認します
• スケーラビリティへの対応をレビューします（シャーディング、レプリカ、キャッシュ）

4. アーキテクチャ評価

• サービスの境界と分割を評価します
• 通信パターンをレビューします（同期／非同期、イベント駆動）
• レジリエンスパターンを評価します（サーキットブレーカー、リトライ、タイムアウト）
• サービスディスカバリーとロードバランシングの設計を確認します
• データ管理と整合性の戦略を検証します

5. セキュリティレビュー

• 認証メカニズムを評価します（OAuth 2.0、JWT）
• 認可モデルをレビューします（RBAC、ABAC）
• データ保護を評価します（保存時／転送時の暗号化、シークレット）
• 入力検証とインジェクション防止策を確認します
• セキュリティ監視と監査ログをレビューします

6. パフォーマンスとスケーラビリティ

• キャッシュ戦略を評価します（レイヤー、無効化、TTL）
• データベースのインデックス作成とクエリ最適化をレビューします
• 水平／垂直スケーリングのアプローチを評価します
• ロードバランシングとオートスケーリングの設計を確認します
• 非同期処理パターンをレビューします

7. レポート作成

• 重要度別に指摘事項を分類します（Critical、High、Medium、Low）
• 詳細な指摘事項を例とともに記録します
• 具体的で実行可能な推奨事項を提示します
• アーキテクチャ改善図を作成します
• 実装ロードマップと優先順位を定めます

レビュー範囲

API 設計の品質

• RESTful API の評価（リソースモデリング、HTTP メソッド、ステータスコード、バージョニング）
• GraphQL スキーマのレビュー（型、リゾルバー、複雑さ、N+1 の防止）
• gRPC サービスのレビュー（Protocol Buffers 定義、ストリーミング、エラー処理）
• API ドキュメントの品質（OpenAPI／Swagger の網羅性）
• API セキュリティ設計（認証、認可、レート制限、検証）

データベースアーキテクチャ

• データモデリング（エンティティ間の関係、正規化、ドメインとの整合性）
• スキーマ設計（テーブル、カラム、制約、インデックス、パーティショニング）
• クエリパターン（効率性、インデックスの使用、N+1 の防止）
• データ整合性（参照整合性、制約、検証）
• スケーラビリティ（シャーディング、読み取りレプリカ、キャッシュ）

マイクロサービスのパターン

• サービスの境界（分割、境界づけられたコンテキスト、DDD との整合性）
• 通信パターン（同期／非同期、イベント駆動、オーケストレーション）
• データ管理（サービスごとのデータベース、結果整合性、サガ）
• サービスディスカバリー（レジストリ、ロードバランシング）
• レジリエンス（サーキットブレーカー、リトライ、タイムアウト、バルクヘッド）

インテグレーションアーキテクチャ

• インテグレーションパターン（API、メッセージキュー、イベントストリーミング、Webhook）
• メッセージキューの設計（選定、スキーマ、DLQ、冪等性）
• イベントストリーミング（イベントソーシング、CQRS、ストリーム処理）
• 外部 API との連携（リトライロジック、サーキットブレーカー、バージョニング）
• バッチ処理（ETL、ジョブスケジューリング、エラー処理）

セキュリティアーキテクチャ

• 認証設計（JWT、OAuth 2.0、セッション管理）
• 認可設計（RBAC、ABAC、権限モデル）
• データ保護（保存時／転送時の暗号化、シークレット管理）
• API セキュリティ（検証、インジェクション防止、レート制限）
• セキュリティ監視（監査ログ、異常検知）

重大度レベル

指摘事項には、次の重大度評価を使用してください。

• 🔴 Critical：セキュリティリスク、データ損失、機能の破損。実装前に必ず修正してください
• 🟠 High：スケーラビリティ、パフォーマンス、信頼性に影響する重大な欠陥。本番稼働前に修正してください
• 🟡 Medium：中程度の問題、またはベストプラクティスからの逸脱。次のイテレーションで対処してください
• 🟢 Low：軽微な改善や最適化。今後の改善項目として記録してください

レポートの構成

バックエンド設計レビューの指摘事項は、次の構成で提示してください。

1. エグゼクティブサマリー - プロジェクトの背景、レビュー日、総合評価
2. レビュー範囲 - レビュー対象、レビューの深さ、重点領域
3. 主な指摘事項の概要 - Critical および High の問題の概要
4. 詳細な指摘事項 - 各指摘事項の重大度、説明、影響、推奨事項、例
5. 肯定的な所見 - 強みと優れた設計上の判断
6. 推奨事項 - 優先順位を付けた改善案と実装ガイダンス
7. アーキテクチャ図 - 現状と改善案
8. アクションアイテム - 担当者、期限、進捗状況を含む具体的なタスク
9. 次のステップ - 直ちに行う対応、短期タスク、フォローアップレビューのスケジュール

参考ファイル

レビューのニーズに応じて、詳細なガイダンスを参照してください。

• レビューのプロセス：API 設計、データベースの検証、マイクロサービスの評価、セキュリティレビュー、パフォーマンス評価を網羅した包括的なステップごとのレビューワークフローと詳細なチェックリストについては、backend-design-review-process.md を参照してください

• API 設計パターン：RESTful API、GraphQL スキーマ、gRPC サービスをレビューする際は、リソースモデリング、HTTP メソッド、ステータスコード、バージョン管理戦略、認証パターン、よくあるアンチパターンを含む api-design-patterns.md を参照してください

• データベース設計パターン：データモデリング、正規化、インデックス戦略、クエリ最適化、データベースのスケーリングパターン、NoSQL パターン、キャッシュ戦略に関する詳細なガイダンスについては、database-design-patterns.md を参照してください

• マイクロサービスと統合パターン：マイクロサービスアーキテクチャ、サービス境界、通信パターン、レジリエンスパターン、メッセージキュー、イベントストリーミング、分散システムの設計をレビューする際は、microservices-integration-patterns.md を参照してください

• レポートテンプレート：エグゼクティブサマリー、指摘事項、推奨事項、アーキテクチャ図、アクションアイテムの各セクションを含むレポートの完全な構成については、report-template.md を参照してください

• 重大度レベル：重大度評価基準（Critical、High、Medium、Low）の詳細と例、対応要件については、severity-levels.md を参照してください