VideoQの設計ドキュメントです。現行実装をベースに、要件定義からアーキテクチャ設計、データベース設計、詳細設計までをまとめています。
以下の順に読むと、全体像から詳細へとスムーズに理解できます。
プロダクトの機能要件とユーザー体験の定義です。
| ドキュメント | 説明 |
|---|---|
| ユースケース図 | ユーザー・管理者・ゲスト・APIクライアントの操作一覧 |
| アクティビティ図 | 主要な業務フローの流れ |
| 画面遷移図 | フロントエンドの画面遷移とルーティング |
システム全体の構成と処理フローの設計です。
| ドキュメント | 説明 |
|---|---|
| システム構成図 | 全体アーキテクチャ、レイヤー構成、セキュリティ |
| フローチャート | 主要処理フロー（アップロード、チャット、認証 等） |
| BPMN | ビジネスプロセスモデル（登録、文字起こし、共有 等） |
| プロンプトエンジニアリング | RAGプロンプトの設計とカスタマイズ方法 |
データモデルとデータフローの定義です。
| ドキュメント | 説明 |
|---|---|
| ER図 | エンティティ関連図とリレーション詳細 |
| データ辞書 | テーブル・カラム定義、制約、インデックス |
| データフロー図 | 機能ごとのデータの流れ |
コンポーネント構成とインタラクション設計です。
| ドキュメント | 説明 |
|---|---|
| コンポーネント図 | フロントエンド・バックエンドのコンポーネント構成 |
| クラス図 | モデル、ドメイン抽象、ユースケース、ビュー |
| シーケンス図 | 主要機能の処理シーケンス |
| 状態遷移図 | 動画・ユーザー・共有・APIキー等の状態遷移 |
| デプロイメント図 | Docker Compose構成、ネットワーク、ボリューム |
| ドキュメント | 説明 |
|---|---|
| PLOG | 前提関係グラフ・学習モード・構築パイプライン |
| レイヤー | 技術 |
|---|---|
| フロントエンド | React 19, TypeScript 5, Vite 7, React Router 7, i18next, TanStack Query 5, Tailwind CSS 4, Radix UI |
| バックエンド | Django 5.2, Django REST Framework, SimpleJWT, Celery, Gunicorn + UvicornWorker (ローカル), AWS Lambda Web Adapter (本番) |
| データベース | PostgreSQL 17 + pgvector (本番は Neon Serverless PostgreSQL) |
| キャッシュ/キュー | Redis (ローカル), Amazon SQS (本番) |
| AI/ML | OpenAI API, Ollama, whisper.cpp, LangChain, Janome, NLTK |
| 利用枠管理 | User の上限値・使用量を quota ドメインで検証（管理者がユーザー単位で設定） |
| インフラ | [ローカル] Docker Compose, Caddy, Nginx [本番] AWS CDK, AWS Lambda, API Gateway, CloudFront, Cloudflare Pages, Cloudflare R2 |