update-docs
ドキュメント更新スキル(仕様書、設計書、README等の更新)
When & Why to Use This Skill
The Update Docs skill is designed to automate the maintenance and synchronization of technical documentation throughout the software development lifecycle. It intelligently handles updates for functional specifications, database designs, error code registries, and README files, ensuring that project documentation remains accurate, consistent, and properly formatted in Markdown without manual overhead.
Use Cases
- Feature Specification Alignment: Automatically update functional specifications (specification.md) to reflect changes in logic or user requirements during the development phase.
- Database Design Synchronization: Keep architecture documents (database-design.md) current by updating schema definitions and table structures as the database evolves.
- Centralized Error Code Management: Maintain a consistent error code registry (error-codes.md) by automatically adding or modifying error definitions as new exceptions are implemented.
- Project README Maintenance: Ensure that the project's entry point (README.md) always contains the latest installation steps, configuration guides, and directory descriptions.
| name | update-docs |
|---|---|
| description | ドキュメント更新スキル(仕様書、設計書、README等の更新) |
Update Docs Skill - ドキュメント更新スキル
役割
プロジェクトドキュメントの更新を支援するスキルです。機能仕様書、DB設計書、エラーコード一覧、README等の更新を行います。
実行フロー
Phase 1: ドキュメントタイプ判定
document_type="feature"
- 対象:
documents/features/[機能名]/specification.md - 更新内容: 機能仕様書の更新
document_type="database"
- 対象:
documents/architecture/database-design.md - 更新内容: データベース設計の更新
document_type="errors"
- 対象:
documents/development/error-codes.md - 更新内容: エラーコード一覧の更新
document_type="readme"
- 対象:
README.mdまたは各ディレクトリのREADME.md - 更新内容: README の更新
Phase 2: ドキュメント読み込み
# ドキュメントファイルを読み込み
cat [document_path]
Phase 3: 更新内容の適用
- update_content に基づいて更新
- 既存の構造を維持
- Markdown形式を保持
Phase 4: 更新確認
- 更新後のドキュメント内容を確認
- Markdown構文エラーがないか確認
Phase 5: 完了報告
## Update Docs 完了報告
### 更新ドキュメント
- **タイプ**: [document_type]
- **パス**: [document_path]
### 更新内容
- [update_content]
### 次のステップ
変更内容を確認し、必要に応じてコミットしてください。