GraphVisAgent 仕様書
1. はじめに
このドキュメント群は、GraphVisAgentアプリケーションの技術仕様を、読者の役割や技術的習熟度に応じて階層的に定義します。
GraphVisAgentは、ユーザーがネットワーク構造をインタラクティブに可視化し、大規模言語モデル（LLM）との対話を通じて分析を行うためのWebアプリケーションです。研究者や開発者が、専門的な知識なしにネットワークの特徴を把握したり、インサイトを得たりすることを目的としています。
2. レイヤード・ドキュメンテーション
本仕様書は、情報を探す目的や読者の背景知識に応じて、最適なドキュメントが見つかるように「レイヤード・ドキュメンテーション」のアプローチを採用しています。
レベル0: エグゼクティブサマリー
- 対象読者: プロジェクトの意思決定者、マネージャー、企画担当者
- 内容: プロジェクトの目的、ビジネス価値、ターゲットユーザー、システム全体の概要など、技術的な詳細を省いた高レベルな情報を提供します。
- 前提知識: ビジネス、プロジェクトマネジメントの基本知識
レベル1: クイックスタートガイド
- 対象読者: 新しくプロジェクトに参加した開発者
- 内容: ローカルでの開発環境のセットアップ手順、アプリケーションの起動方法、基本的な開発フローなど、すぐに開発を始めるために必要な実践的情報を提供します。
- 前提知識: Git, Node.js, Docker, React, FastAPIに関する基本的な開発経験
レベル2: 詳細技術仕様
- 対象読者: 実装を担当する開発者、アーキテクト
- 内容: システムのアーキテクチャ、各コンポーネント（Backend, Frontend, NetworkXMCP）の内部設計、API仕様、データベーススキーマ、主要な処理フローなど、実装に必要な全ての技術的な詳細情報を提供します。
- 前提知識: 各技術スタック（FastAPI, React, NetworkX, PostgreSQLなど）に関する深い知識
各ドキュメントには、冒頭に**「前提知識レベル」**が明記されています。ご自身の目的に合ったレベルのドキュメントからお読みください。