← Back to list

doc-sync-checker
by s4k10503
Unityによるアバターシステムクライアント
⭐ 0🍴 0📅 Jan 24, 2026
SKILL.md
name: doc-sync-checker description: Checks if docs need updates. MUST use proactively after adding new public APIs, breaking changes, or significant architectural changes. Also triggers on "ドキュメント", "docs". allowed-tools: Read, Grep, Glob
Document Sync Checker
Execution Mode
サブエージェント必須: 必ずサブエージェントで実行する。
実行パターン
- Exploreサブエージェント で変更ファイルとドキュメントを比較
- 更新必要リストのみをメインに返却
- 実際の更新はメインで実施
サブエージェントプロンプト
以下のプロンプトで runSubagent を呼び出す:
runSubagent(
description: "ドキュメント同期チェック",
prompt: """
以下の手順でドキュメント更新漏れを検出してください:
1. git diff --name-only で変更ファイルを特定
2. 下記マッピングに基づき対応ドキュメントを特定:
- Domain → docs/Spec/domain-layer.md
- Application → docs/Spec/application-layer.md
- Infrastructure → docs/Spec/infrastructure-layer.md
- Presentation → docs/Spec/presentation-layer.md, docs/Spec/view-architecture.md
- DI設定 → docs/Spec/dependency-injection.md
- テスト → docs/Spec/testing-strategy.md
3. 各変更について更新必要性を判断:
- 必須: 新規public API、破壊的変更
- 推奨: パターン追加、例の更新
- 任意: 軽微な修正、内部リファクタリング
## 返却フォーマット(厳守)
### 更新必要リスト
| 変更ファイル | 対応ドキュメント | 重要度 | 更新内容 |
|-------------|-----------------|--------|----------|
| path/to/file.cs | docs/Spec/xxx.md | 必須 | 新規APIの追加 |
### サマリー
- 必須更新: N件
- 推奨更新: N件
- 更新不要: N件
更新不要の場合は「ドキュメント更新不要」と報告。
"""
)
References
ドキュメント構造は以下を参照:
- ドキュメント索引: docs/README.md
Document Mapping
| 変更パス | 対応ドキュメント |
|---|---|
Features/*/Domain/ | docs/Spec/domain-layer.md |
Features/*/Application/ | docs/Spec/application-layer.md |
Features/*/Infrastructure/ | docs/Spec/infrastructure-layer.md |
Features/*/Presentation/ | docs/Spec/presentation-layer.md, docs/Spec/view-architecture.md |
Shared/Core/ | docs/Spec/domain-layer.md, docs/Spec/application-layer.md |
Shared/Infrastructure/ | docs/Spec/infrastructure-layer.md |
Shared/Presentation/ | docs/Spec/presentation-layer.md |
Composition/Installers/ | docs/Spec/dependency-injection.md |
| テスト | docs/Spec/testing-strategy.md |
注: 新Feature追加時、上記のワイルドカードパターンにより自動的にマッピングされる。
Workflow
git diff --name-onlyで変更ファイルを特定- 上記マッピングで対応ドキュメントを特定
- 更新が必要かどうか判断
- 具体的な更新提案を報告
Priority
| 重要度 | 条件 |
|---|---|
| 必須 | 新規public API、破壊的変更 |
| 推奨 | パターン追加、例の更新 |
| 任意 | 軽微な修正、内部リファクタリング |
Score
Total Score
55/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon
