entity-relation-based-documentation

📚 Entity-Relation Based Documentation

Version: 2.0.0 Last Updated: 2025-11-22 Priority: ⭐⭐⭐ (P2 Level) Purpose: Miyabi Entity-Relationモデルに基づくドキュメント自動生成

📋 概要

Miyabiの14エンティティ・39リレーションモデルに基づいた ドキュメント生成、Mermaidダイアグラム作成を提供します。

🎯 P0: 呼び出しトリガー

🔧 P1: Entity-Relationモデル

14 Entities

39 Relations（カテゴリ別）

🚀 P2: ドキュメントパターン

Pattern 1: 機能ドキュメント

# [機能名]

## 概要
[1-2文で説明]

## Entity関係
- 主要Entity: [Entity名]
- 関連Entity: [Entity1], [Entity2]
- 使用Relations: R1, R9, R16

## 実装ファイル
- `crates/miyabi-xxx/src/lib.rs`
- `crates/miyabi-xxx/src/feature.rs`

## 使用方法
[コード例]

## 関連ドキュメント
- [リンク1]
- [リンク2]

Pattern 2: Mermaidダイアグラム

graph TD
    Issue[Issue] -->|R1| Task[Task]
    Task -->|R9| Agent[Agent]
    Agent -->|R12| PR[PR]
    Agent -->|R19| QualityReport[QualityReport]

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

# [コンポーネント名] Architecture

## レイヤー構造

[ASCII図]

## データフロー
[Mermaid sequence diagram]

## 依存関係
[依存グラフ]

⚡ P3: 自動生成ワークフロー

Step 1: Entity特定

# コードからEntity参照を抽出
grep -r "Issue\|Task\|Agent" crates/

Step 2: Relation特定

# 関係性パターンを検出
# creates, updates, triggers, etc.

Step 3: ドキュメント生成

自動生成セクション:
- [ ] 概要
- [ ] Entity関係図
- [ ] ファイルマッピング
- [ ] API リファレンス
- [ ] 使用例

✅ 成功基準

🔗 関連ドキュメント

📝 関連Skills

• Rust Development: 実装コード確認
• Issue Analysis: Issue分析結果
• Git Workflow: 変更履歴参照