update-docs
Update documentation after code changes. Use when API endpoints, database schema, backend/frontend structure, or block definitions have been modified.
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求,再添加到工作流。
查看来源 ↗使用指南技能说明
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作成へ進む。
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-26
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!