mcpField
A
architecture-documentation

architecture-documentation

github.com/melodic-software開発28180 回インストール今日更新
リポジトリ

architecture-documentation について

architecture-documentation は、関係者ごとのシステムアーキテクチャ文書を作成するスキルです。C4 図に加え、デプロイやデータ、エグゼクティブサマリーなどを扱い、作成手順と完成度チェックリストを備えています。

主な機能

  1. 01C4 のコンテキスト、コンテナ、コンポーネント文書
  2. 02デプロイとデータのアーキテクチャ文書
  3. 03対象者に応じた視点の選択
  4. 04可視化プラグインによる図の統合
  5. 05文書の完成度チェック

活用シーン

  1. 01システムのアーキテクチャ文書作成
  2. 02開発者向けのコンポーネント構造記述
  3. 03運用担当向けのデプロイ環境記録
  4. 04経営層向け技術概要の作成

インストール

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

$npx skills add https://github.com/melodic-software/claude-code-plugins --skill architecture-documentation

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

詳細

アーキテクチャドキュメント

このスキルを使用するタイミング

次のことが必要な場合に、このスキルを使用してください。

  • システムのアーキテクチャドキュメントを生成する
  • C4 図（コンテキスト、コンテナ、コンポーネント）を作成する
  • さまざまなステークホルダーの視点に合わせてアーキテクチャを文書化する
  • 技術概要やエグゼクティブサマリーを作成する

キーワード： ドキュメント、c4、コンテナ、コンテキスト、コンポーネント、視点、アーキテクチャ記述、技術概要、エグゼクティブサマリー

ドキュメントの種類

種類対象読者内容
コンテキストすべてのステークホルダーシステム境界、外部とのやり取り
コンテナ技術リードサービス、データベース、主要コンポーネント
コンポーネント開発者コンテナの内部構造
デプロイメント運用担当者インフラストラクチャ、環境
データデータアーキテクトデータフロー、ストレージ、スキーマ
エグゼクティブサマリー経営陣ビジネス価値、重要な決定事項

ドキュメント生成ワークフロー

1. コードベースを分析する

ドキュメントを生成する前に、次のことを行います。

  1. 対象範囲を特定する（単一サービス、複数のサービス、システム全体）
  2. 取り込む既存のドキュメントを探す
  3. 主要なアーキテクチャ関連ファイル（設定ファイル、デプロイ仕様）を特定する
2. ドキュメントの種類を選択する

次の項目に基づいて選択します。

  • 対象読者：誰が読むのか？
  • 目的：意思決定の支援、オンボーディング、コンプライアンスのどれか？
  • 対象範囲：コンポーネント、サービス、システムのどのレベルか？
3. ドキュメントを生成する

各ドキュメントには標準的な構成があります。

コンテキストドキュメント
# System Context: [System Name]

## Overview
[1-2 paragraph description]

## Context Diagram
[C4 Context diagram - via visualization plugin]

## External Systems
| System | Description | Integration |
| --- | --- | --- |
| ... | ... | ... |

## Users/Actors
| Actor | Description | Interactions |
| --- | --- | --- |
| ... | ... | ... |
コンテナドキュメント
# Container Architecture: [System Name]

## Overview
[Architecture summary]

## Container Diagram
[C4 Container diagram - via visualization plugin]

## Containers
### [Container Name]
- **Technology**: [Stack]
- **Purpose**: [Description]
- **Responsibilities**: [List]
- **Dependencies**: [List]
コンポーネントドキュメント
# Component Architecture: [Container Name]

## Overview
[Component structure summary]

## Component Diagram
[C4 Component diagram - via visualization plugin]

## Components
### [Component Name]
- **Type**: [Service/Repository/Controller/etc.]
- **Responsibilities**: [List]
- **Interfaces**: [Public APIs]
4. 図を組み込む

可視化プラグインが利用できる場合は、次の手順を実行します。

  1. visualization:diagram-generator エージェントを呼び出す
  2. 適切な C4 図の種類を指定する
  3. 生成された Mermaid／PlantUML コードをドキュメントに埋め込む

代替手段： 可視化プラグインが利用できない場合は、テキスト形式でアーキテクチャを記述し、可視化プラグインを使って図を追加できることを記載します。

テンプレートの構成

すべてのアーキテクチャドキュメントに、次の項目を含めてください。

  1. ヘッダー：タイトル、バージョン、日付、作成者
  2. 概要：1～2 段落の要約
  3. 図：視覚的な表現
  4. 詳細：コンポーネントに関する構造化された情報
  5. 決定事項：関連する ADR へのリンク
  6. 参考資料：関連ドキュメントへのリンク

完全性チェックリスト

ドキュメントを完成させる前に、次の項目を確認してください。

  • 対象範囲が明確に定義されている
  • すべての主要コンポーネントが特定されている
  • 外部依存関係が文書化されている
  • 重要な決定事項が ADR にリンクされている
  • 図とテキストによる説明が一致している
  • 対象読者に適した言葉遣いが使用されている
  • バージョンと日付が記載されている

リポジトリ内の配置場所

生成したドキュメントは、次の場所に配置してください。

/architecture/
  /viewpoints/
    context.md
    containers.md
    components/
      [container-name].md
    executive-summary.md

他のスキルとの連携

  • adr-management：ドキュメント内で関連する ADR にリンクする
  • togaf-guidance：現在の ADM フェーズに沿っていることを確認する
  • zachman-analysis：適切な視点が網羅されていることを確認する

バージョン履歴

  • v1.0.0 (2025-12-05)：初回リリース
    • C4 図のドキュメント生成ワークフロー
    • 6 種類のドキュメント（コンテキスト、コンテナ、コンポーネント、デプロイメント、データ、エグゼクティブサマリー）
    • 可視化プラグインとの連携
    • 完全性チェックリスト

最終更新日

日付： 2025-12-05 モデル： claude-opus-4-5-20251101

コメント

Markdown 対応