cs-arch (アーキテクチャ管理) は何をしますか?
.codestable/architecture/ にシステムの現状を記録するマップを維持します。3つのモード(update / check / backfill)を提供します。
トリガー: ユーザーが「アーキテクチャをリフレッシュ」「アーキテクチャチェックを実行」「このモジュールのアーキテクチャドキュメントを補完」「設計とコードは一致しているか」などと発言したとき、またはフィーチャー開発フェーズで事前にアーキテクチャアクションが必要な場合に自動的に起動します。
将来計画は記述しません(将来計画は cs-roadmap スキルを使用してください)。
モード一覧
| モード | 説明 |
|---|---|
| update | コードベースの変更を .codestable/architecture/ に反映し、既存ドキュメントを最新に更新します。 |
| check | 現在のコードと .codestable/architecture/ の内容を比較し、整合性を検証します。乖離がある場合は警告を出力します。 |
| backfill | アーキテクチャドキュメントが未作成のモジュールについて、コードから自動的にドキュメントを生成して補完します。 |
使用方法
update:アーキテクチャをリフレッシュまたはupdate architectureと発言します。check:アーキテクチャチェックを実行またはcheck architectureと発言します。backfill:このモジュールのアーキテクチャドキュメントを補完またはbackfill architecture for <module>と発言します。
制約
- このスキルは
.codestable/architecture/内のファイルのみを読み書きします。 - コードベースの分析には静的解析ツールなどを使用します。
- 将来の設計、ロードマップ、計画はこのスキルでは記録しません。別スキル
cs-roadmapを使用してください。
ファイル構成例
.codestable/
└── architecture/
├── overview.md # システム全体のアーキテクチャ概要
├── module-a.md # モジュールAのアーキテクチャ
└── module-b.md # モジュールBのアーキテクチャ
注意事項
- ドキュメントは常に 現在のコードの状態 を正確に反映するものとします。
- ドキュメントがコードと一致しない場合、
checkモードで警告が表示されます。 - フィーチャー開発の前に
updateまたはbackfillを実行することで、正確な現状マップを基に開発を進められます。