← スキル一覧に戻る
update-docs
by so-ta
⭐ 0🍴 0📅 2026年1月23日
Manusで実行SKILL.md
name: update-docs description: | Update documentation after code changes. Use when API endpoints, database schema, backend/frontend structure, or block definitions have been modified.
Update Documentation
コード変更に伴うドキュメント更新。
更新判定
| 変更内容 | 更新対象ドキュメント |
|---|---|
| APIエンドポイント追加/変更 | docs/API.md, backend/openapi.yaml |
| DBスキーマ変更 | docs/DATABASE.md |
| 新規ブロック追加 | docs/BLOCK_REGISTRY.md |
| Backend構造変更 | docs/BACKEND.md |
| Frontend構造変更 | docs/FRONTEND.md |
| 新規composable追加 | docs/FRONTEND.md |
更新手順
1. 変更内容を特定
git diff --stat
2. 該当ドキュメントを確認
対象ドキュメントを読み、既存の記載形式を確認する。
3. ドキュメントを更新
既存の形式に合わせて更新。以下を心がける:
- 簡潔で明確な説明
- 具体的な使用例
- 関連コードへのパス参照
4. 整合性確認
- コードとドキュメントの整合性
- 他ドキュメントへの参照リンクが有効か
更新不要なケース
- 内部リファクタリングのみ（外部インターフェース変更なし）
- テストコードのみの変更
- コメント・フォーマット修正のみ
次のステップ
ドキュメント更新完了後、PR作成へ進む。
スコア
総合スコア
40/100
リポジトリの品質指標に基づく評価
✓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
レビュー
💬
レビュー機能は近日公開予定です