mcpField
B
backend-design

backend-design

github.com/dauquangthanh開発17124 回インストール40 週間前に更新
リポジトリ

backend-design について

要件からアーキテクチャ、API、データベース、セキュリティ、拡張性までを計画するスキルです。実装計画を準備するチーム向けに、体系的な設計手順と出力構成を示します。

主な機能

  1. 01要件と制約の分析
  2. 02アーキテクチャとサービス境界
  3. 03REST API とスキーマ設計
  4. 04データベースのモデリングと索引
  5. 05認証・認可の計画
  6. 06拡張性とドキュメントの指針

活用シーン

  1. 01要件をバックエンド構成に落とし込む
  2. 02API 契約とバージョンを計画
  3. 03データベースのエンティティと索引を設計
  4. 04セキュリティと拡張性の計画を作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/dauquangthanh/hanoi-rainbow --skill backend-design

インストール後、Claude Code で/backend-designを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
api-design-guide.md
backend-design-process.md
best-practices.md
common-patterns.md
database-design.md
examples.md

詳細

バックエンド設計

ワークフロー

次の体系的な設計プロセスに従ってください。

  1. 要件分析

    • 機能要件（機能、操作）を収集します
    • 非機能要件（パフォーマンス、スケーラビリティ、可用性）を定義します
    • 制約（予算、スケジュール、テクノロジー、コンプライアンス）を特定します

  2. アーキテクチャの選定

    • アーキテクチャパターン（モノリス、マイクロサービス、サーバーレス）を選択します
    • 要件に基づいてテクノロジースタックを選定します
    • サービスの境界と責任を定義します

  3. API 設計

    • 適切なリソースモデリングに基づいて RESTful エンドポイントを設計します
    • リクエスト／レスポンスのスキーマとコントラクトを定義します
    • バージョニング戦略とドキュメントを計画します
    • REST／GraphQL／gRPC のパターンについては、api-design-guide.md を参照してください

  4. データベース設計

    • エンティティとリレーションシップをモデル化します
    • 正規化を考慮してスキーマを設計します
    • インデックス作成とパーティショニングの戦略を計画します
    • リレーショナルデータベースと NoSQL のパターンについては、database-design.md を参照してください

  5. セキュリティ設計

    • 認証フロー（OAuth 2.0、JWT）を設計します
    • 認可モデル（RBAC、ABAC）を計画します
    • データの暗号化と保護の戦略を定義します

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

    • キャッシュ戦略（Redis、CDN）を設計します
    • 負荷分散と自動スケーリングを計画します
    • メッセージキューを使用した非同期処理を定義します

  7. ドキュメント

    • API 仕様（OpenAPI／Swagger）を作成します
    • Mermaid 図を使ってアーキテクチャの決定事項を文書化します
    • 実装ガイドラインとロードマップを提示します

出力構成

バックエンド設計は、次のセクションで提示してください。

  1. システム概要 - 高レベルのアーキテクチャ、コンポーネント、テクノロジースタック
  2. API 仕様 - エンドポイント、スキーマ、認証、OpenAPI ドキュメント
  3. データベース設計 - ERD、スキーマ、インデックス、移行計画
  4. アーキテクチャの決定事項 - サービス分割、通信パターン、一貫性モデル
  5. セキュリティの実装 - 認証／認可フロー、暗号化
  6. スケーラビリティ計画 - 負荷分散、キャッシュ、データベースのスケーリング、自動スケーリング
  7. デプロイアーキテクチャ - コンテナ、インフラストラクチャ、CI/CD、モニタリング
  8. 実装ロードマップ - フェーズ、マイルストーン、依存関係、リスク

基本原則

  • API ファーストのアプローチ - 実装の前に API を設計し、文書化します
  • セキュリティ・バイ・デザイン - 認証、認可、暗号化を最初から組み込みます
  • スケーラビリティを考慮した設計 - キャッシュ、負荷分散、水平スケーリングによる成長を計画します
  • 障害に備える - エラー処理、再試行、サーキットブレーカー、グレースフルデグラデーションを含めます
  • 徹底的に文書化する - 明確な API 仕様、Mermaid によるアーキテクチャ図、実装ガイドを作成します

参考ファイル

具体的なニーズに応じて、追加のリソースを読み込んでください。

  • 詳細な設計プロセス：API 設計、データベースモデリング、認証フロー、マイクロサービスのパターンに関する例を含む、包括的なステップごとのワークフローについては、backend-design-process.mdを参照してください。

  • API 設計ガイド：RESTful API、GraphQL スキーマ、gRPC サービスの設計時は、api-design-guide.mdを参照してください。リソースモデリング、ステータスコード、バージョニング戦略、ドキュメント作成について説明しています。

  • データベース設計：リレーショナルデータベースと NoSQL データベースの設計、正規化、インデックス作成、パーティショニング、レプリケーション戦略に関する詳細なガイダンスについては、database-design.mdを参照してください。

  • ベストプラクティス：API 設計、データベースの最適化、セキュリティ強化、パフォーマンスチューニング、信頼性確保のパターンについては、best-practices.mdを参照してください。

  • 一般的なパターン：リポジトリパターン、サービスレイヤー、依存性注入、その他のアーキテクチャパターンのコード例については、common-patterns.mdを参照してください。

  • プロジェクト例：E コマースシステム、リアルタイムチャットアプリケーション、マイクロサービスの実装など、アーキテクチャの包括的な例については、examples.mdを参照してください。

コメント

Markdown 対応