update-architecture-docs Skill
コードの変更がアーキテクチャに影響を与える場合、ドキュメントの更新を忘れないようにするためのスキルです。
対象ディレクトリ
e:\Tepora_Project\docs\architecture\
手順
変更内容の確認
- クラス構造、データフロー、主要なコンポーネント間の関係が変わったかどうかを確認します。
ドキュメントの更新
- 関連する Markdown ファイル(例:
SYSTEM_ARCHITECTURE.md)を更新します。 - 説明文だけでなく、コードスニペットや参照先も修正します。
- 関連する Markdown ファイル(例:
Mermaid図の更新
- Mermaid記法で記述された図(フローチャート、シーケンス図、クラス図)を更新します。
- 図が現状のコードと矛盾しないようにします。
チェックリスト
- 新しいコンポーネントは図に追加されましたか?
- 廃止されたコンポーネントは図から削除されましたか?
- データフローの矢印は正しい方向を向いていますか?
Converted and distributed by TomeVault — claim your Tome and manage your conversions.