← Back to list

doc-update
by yn1323
10th
⭐ 0🍴 0📅 Jan 22, 2026
SKILL.md
name: doc-update description: 機能実装後のドキュメント更新をサポート。新機能追加、API変更、画面追加、スキーマ変更時に doc/ARCHITECTURE.md、doc/INDEX.md、doc/features/*.md を更新する手順と判断基準を提供。
ドキュメント更新ガイド
更新フロー
- 今回の変更内容を確認
- 下記の判断基準で更新対象を特定
- 該当ドキュメントを更新
- 更新内容をユーザーに報告
更新判断基準
更新が必要
| 変更内容 | 更新対象 |
|---|---|
| 新機能追加 | features/新機能.md 新規作成 + INDEX.md |
| 既存機能の仕様変更 | 該当の features/*.md |
| データモデル変更 | 該当の features/*.md データモデルセクション |
| API追加・削除 | 該当の features/*.md APIセクション |
| 画面追加・削除 | 該当の features/*.md 画面一覧 |
| コンポーネント構造変更 | ARCHITECTURE.md 機能マッピング |
| ディレクトリ構造変更 | ARCHITECTURE.md ディレクトリ構造図 |
| 技術スタック変更 | ARCHITECTURE.md 技術スタック |
| 状態管理変更 | ARCHITECTURE.md 状態管理セクション |
更新不要
- バグ修正(仕様変更なし)
- リファクタリング(構造変更なし)
- スタイル修正
- テスト追加
- パフォーマンス改善
各ファイルの更新内容
doc/ARCHITECTURE.md
- ディレクトリ構造図
- 機能→ファイルマッピング
- ファイル→機能マッピング
- データフロー図
- コンポーネント責務
- 状態管理(Jotai)
- 技術スタック
doc/INDEX.md
- 機能一覧テーブル
- 新機能のリンク追加
doc/features/*.md
テンプレートは templates.md 参照
チェックリスト
- 新しいテーブル/フィールド追加? → データモデル更新
- 新しいAPI追加? → APIセクション更新
- 新しい画面追加? → 画面一覧更新
- 新しいコンポーネント追加? → コンポーネント構成更新
- ディレクトリ構造変更? → ARCHITECTURE.md更新
- 新機能? → features/*.md新規作成 + INDEX.md追加
Score
Total Score
50/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon