アーキテクチャ図

目次

• 概要
• 使用時機
• クイックスタート
• リファレンスガイド
• ベストプラクティス

概要

Mermaid や PlantUML などのコードベースの図作成ツールを使用して、明確で保守しやすいアーキテクチャ図を作成し、システム設計、データフロー、技術ドキュメンテーションに活用します。

使用時機

• システムアーキテクチャドキュメンテーション
• C4モデル図
• データフロー図
• シーケンス図
• コンポーネント関係図
• デプロイメント図
• インフラストラクチャアーキテクチャ
• マイクロサービスアーキテクチャ
• データベーススキーマ（ビジュアル表示）
• 統合パターン

クイックスタート

最小限の動作例：

graph TB
    subgraph "Client Layer"
        Web[Web App]
        Mobile[Mobile App]
        CLI[CLI Tool]
    end

    subgraph "API Gateway Layer"
        Gateway[API Gateway<br/>Rate Limiting<br/>Authentication]
    end

    subgraph "Service Layer"
        Auth[Auth Service]
        User[User Service]
        Order[Order Service]
        Payment[Payment Service]
        Notification[Notification Service]
    end

    subgraph "Data Layer"
        UserDB[(User DB<br/>PostgreSQL)]
        OrderDB[(Order DB<br/>PostgreSQL)]
        Cache[(Redis Cache)]
        Queue[Message Queue<br/>RabbitMQ]
    end
// ... (詳細な実装についてはリファレンスガイドを参照)

リファレンスガイド

references/ ディレクトリの詳細な実装：

ガイド	内容
システムアーキテクチャ図	システムアーキテクチャ図
シーケンス図	シーケンス図
C4 コンテキスト図	C4 コンテキスト図
コンポーネント図	コンポーネント図
デプロイメント図	デプロイメント図
データフロー図	データフロー図
クラス図	クラス図
コンポーネント図	コンポーネント図
デプロイメント図	デプロイメント図

ベストプラクティス

✅ 実施すべき項目

• 一貫性のある表記法と記号を使用する
• 複雑な図には凡例を含める
• 図を1つの側面に焦点を当てる
• 色分けを意味のある方法で使用する
• タイトルと説明を含める
• 図をバージョン管理する
• テキストベースの形式（Mermaid、PlantUML）を使用する
• データフローの方向を明確に示す
• デプロイメント詳細を含める
• 図の規則を文書化する
• 図をコードと同期させておく
• 論理的なグループ化のためにサブグラフを使用する

❌ 実施してはいけない項目

• 図を詳細情報で過度に詰め込む
• 不一貫なスタイルを使用する
• 図の凡例をスキップする
• バイナリ画像ファイルだけを作成する
• 関係の文書化を忘れる
• 1つの図に複数の抽象化レベルを混在させる
• 独自形式を使用する