| name | spec-format |
| description | 仕様書の新規作成・更新を所定のテンプレートと記述規約に沿って行うスキル。USE WHEN: ユーザが「仕様書を書いて」「スペックを作って」「specを書いて」「仕様をまとめて」「設計書を作成」「実装仕様を起こして」「機能仕様を定義して」「FEATURE_NAME.md を作って」など、仕様書・設計書の作成や更新を依頼したとき。spec/ 配下の作業仕様を扱うときも必ず参照すること。 |
仕様書構成様式スキル
仕様書を spec/wip/ と spec/complete/ 配下に統一フォーマットで作成・管理するためのスキル。
ファイル配置ルール
| 状態 | 配置先 |
|---|
| 新規執筆・着手中 | spec/wip/local_{連番}/FEATURE_NAME.md |
| 完了済み | spec/complete/local_{連番}/FEATURE_NAME.md |
- ファイル名は大文字スネークケース (
FEATURE_NAME.md)。
- 連番は既存ディレクトリを確認し、次の番号を採番する。
- 実装完了後は
wip から complete へディレクトリごと移動する。
spec/initial/ は初期構想の置き場として扱い、作業完了管理には使わない。
テンプレートの使い方
仕様書を作成する際は references/template.md を読み込み、テンプレートに沿ってセクションを埋める。
read references/template.md from this skill directory
テンプレートの各セクションにあるガイドコメント (<!-- ... -->) は出力に含めない。
記述規約
- 用語定義は表形式で統一する。
- コード例は実装言語のコードブロックで記載する。
- 性能要件・期待効果は表形式で定量的に記載する。
- TDD で進める作業は、振る舞い仕様と TDD Test List を実装設計から分けて記載する。
- チェックリストはタスク完了後に
[x] で更新する。
- 事実と仮説を明確に書き分ける。
- 実機 new 3DS XL を使う作業は、実機条件・marker・安全制約を明記する。
cc3dsfs 由来の定数・command・構造体サイズは参照元の path または URL を記載する。
TDD 連携
振る舞い仕様 には、外部から観測できる入力・状態と期待結果を書く。
TDD Test List には、Canon TDD のテストリストとして実行順候補を記録する。
- テストリストの状態は
todo / red / green / refactor-done / deferred を基本にする。
- テスト項目には実装方法や内部構造を混ぜない。必要な場合は設計メモへ分離する。
ワークフロー
- ユーザの要件を把握し、機能名を決定する。
spec/wip/ と spec/complete/ の既存 local_{連番} を確認し、次の番号を決める。
- テンプレートを読み込み、各セクションを埋める。
- TDD で進める作業では、振る舞い仕様と TDD Test List を作る。
- 対象ファイルの変更種別 (新規 / 修正 / 削除) を明記する。
- チェックリストに実装タスクと検証コマンドを列挙する。
- 実装後、実行結果を反映してチェックリストを更新する。