Back to list
ShunsukeHayashi

entity-relation-based-documentation

by ShunsukeHayashi

🤖 First open-source, economically-governed, beginner-friendly autonomous development framework built on Issue-Driven Development | 超初心者でも使える自律型開発フレームワーク

13🍴 8📅 Jan 24, 2026

SKILL.md


name: Entity-Relation Based Documentation description: Generate documentation based on Miyabi's Entity-Relation Model (14 entities, 39 relationships). Use when documenting features, updating architecture docs, or explaining how components work. allowed-tools: Read, Write, Edit, Grep, Glob

📚 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: 呼び出しトリガー

トリガー
ドキュメント化"document this feature"
アーキテクチャ"update the architecture docs"
説明"explain how X works"
新機能後"after implementing new features"

🔧 P1: Entity-Relationモデル

14 Entities

Entity説明関連数
IssueGitHub Issue8
Task分解されたタスク6
Agent実行Agent7
PRPull Request4
Labelラベル5
QualityReport品質レポート3
CommandCLIコマンド2
Escalationエスカレーション3
Deploymentデプロイメント3
LDDLog学習ログ2
DAGタスクグラフ4
WorktreeGit Worktree4
DiscordCommunityDiscordコミュニティ4
SubIssueサブIssue3

39 Relations(カテゴリ別)

カテゴリRelations
Issue処理R1-R44
Agent実行R9-R157
ラベル制御R16-R183
品質管理R19-R235
並列実行R24-R274
コミュニティR28-R358
階層R36-R394
その他R5-R84

🚀 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 リファレンス
- [ ] 使用例

✅ 成功基準

チェック項目基準
Entity特定関連Entity全て
Relation特定使用Relation全て
ダイアグラムMermaid生成
ファイルマッピング実装ファイル紐付け
例示コード例含む

🔗 関連ドキュメント

ドキュメント用途
docs/ENTITY_RELATION_MODEL.mdERモデル詳細
context/miyabi-definition.md定義一覧
docs/TEMPLATE_MASTER_INDEX.mdテンプレート

📝 関連Skills

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

Score

Total Score

75/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

+10
説明文

100文字以上の説明がある

+10
人気

GitHub Stars 100以上

0/15
最近の活動

1ヶ月以内に更新

+10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

+5

Reviews

💬

Reviews coming soon