0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Copilot に SDD を教え込む話

0
Last updated at Posted at 2025-12-22

TL;DR

  • AWS Kiro の優秀さと便利さに驚きを隠せない
  • Copilot よ、お前もガンバレ

(1) Kiro と 防衛三文書

Kiro

仕様駆動開発 IDE の一つである AWS Kiro では、要件/設計/タスクの三段階の文書を AI 自身が維持し続けることで一貫性を保つ挙動をします。
それぞれの文書は以下の役割を持ちます。

レベル 役割
Requirements(要件) 何を実現したいか(目的・制約)を定義する最上位の文書
Design(設計) 要件を満たすためのアーキテクチャ・構造・方式を決める中位の文書
Tasks(タスク) 設計を実現するための具体的な作業単位(コード生成の粒度)

これは、AI にコーディングを任せるために、上位から下位に向かって曖昧さを消し、実行可能な粒度に分解するための構造だと思われます。

防衛三文書

話は変わって、小泉防衛大臣が防衛力強化のための取組について議論を重ねています。

そこで対象となる「安全保障関連 防衛三文書」は、以下です。

レベル 役割
国家安全保障戦略(NSS) 国家としての目的・理念・安全保障観を規定する最上位文書
国家防衛戦略(NDS) NSS を実現するための防衛方針・やり方(オペレーション・手段)
防衛力整備計画(DBP) 方針を実行するために必要な装備・人員・投資計画などの具体策

この二つ、よく似てるんじゃね?

防衛三文書 AWS Kiro 本質的役割
NSS(国家の目的) Requirements(要件) 最上位の目的・制約を定義する
NDS(戦略・方針) Design(設計) 目的を達成するための方式を決める
DBP(装備・整備計画) Tasks(タスク) 設計を具体的に実行可能な単位に落とす

つまり両者は、

  • 「階層化モデルの普遍性」に基づいた
  • 「構造のアナロジーとして非常によく似たフレームワーク」

だったのだ!

(2) EARS と ADR

AI エージェントが生成するドキュメントを読んでいて気がついた
→ 人間 と AI の両方にとって理解しやすいドキュメントの形式がある

EARS と ADR

EARS ( Easy Approach to Requirements Syntax ) 記法
ADR ( Architecture Decision Record ) 記法

形式 目的 メリット
EARS 機能仕様
WHAT(何をするか)
曖昧さゼロの要求になる(誤解を防ぐ)
正確にコード生成できる(再現性が高い)
ADR 設計・方針・判断理由
WHY(なぜそうするか)
“なぜそうしたか” が後からわかる(背景の記録)
設計のぶれ・誤改修を防ぐ(保守性向上)
  • EARS と ADR は、競合するものではなく、相補的である

copilot-instructions.md

(1)(2) を取り込んで、Copilot よ、いざ、SDD な世界へ!

構造全体はテンプレ参照
https://github.com/exabugs/sdd-template-repo

# Copilot Instructions(SDD / Steering)

このリポジトリは **SDD(Spec-Driven Development)** 方式で開発する。  
コードは仕様の結果であり、**仕様が常に最終決定事項(Single Source of Truth)** である。

Copilot は、以下の仕様・設計・タスク・意思決定履歴を  
**コード変更と同時に最新状態へ保つこと** を前提に振る舞うこと。

---

## リポジトリ構成(前提 / 分割SSOT)

```text
repo/
  spec/                      # SSOT(最終決定事項)
    requirements/            # 要件(EARS)
      index.md               # 入口(章立て・リンク・採番ルール)
      <domain>.md            # 例: auth.md, billing.md, admin.md ...
    design/                  # 設計
      index.md               # 入口(章立て・リンク・Traceability)
      <domain>.md            # 例: auth.md, api.md, data-model.md ...
    tasks/                   # タスク(必要に応じて分割)
      index.md
      <stream>.md

  docs/
    adr/                     # ADR(Architecture Decision Record)
      README.md              # ADR ルール・テンプレ
      0001-*.md
      0002-*.md

  steering/                  # 運用ガードレール(SSOT ではない)
    README.md
    coding-style.md
    dev-workflow.md
    testing-quality.md
    security.md
    dependencies.md

  src/                       # アプリケーションコード
  tests/                     # テスト

  copilot-instructions.md
  README.md
```

- `spec/` 配下は **常に最新・最終決定版(SSOT)**
- `spec/*/index.md`**入口(目次・導線・採番・方針)**
- `spec/*/<domain>.md`**本文(分割単位)**
- `docs/adr/`**意思決定の履歴(追記のみ)**
- `steering/`**運用・規約・品質基準を定義するガードレール層**
- コードと仕様が乖離した場合、**仕様が正** とみなす

---

## 仕様ドキュメントの役割(SSOT)

### requirements(要件)
- **「何を満たすべきか」** を定義する
- **EARS(Easy Approach to Requirements Syntax)記法**で記載する
- 実装方法や内部構造は書かない(What のみ)

### design(設計)
- requirements を **どのように満たすか**
- アーキテクチャ、責務分離、データ構造、フロー、エラー方針などを記述
- 実装が設計と異なる場合、**設計か実装のどちらかを必ず更新**

### tasks(タスク)
- 実装・修正・調査の **実行単位**
- 進捗が分かるようチェックリスト形式で管理
- 次にやるべき作業が常に分かる状態を保つ

---

## Steering(運用ガードレール)について

本リポジトリでは、**SSOT(最終決定版の仕様)とは別レイヤ**として  
**Steering(運用ガードレール)**を設ける。

Steering は、以下を目的とする。

- 開発の進め方・判断基準・禁止事項を固定する
- 人間および Copilot の振る舞いを一貫させる
- 仕様(spec)や設計の内容そのものとは分離する

Steering に含めるのは **運用・規約・品質基準**のみとし、  
要件・設計・タスクなどの**決定事項そのものは spec/ を SSOT とする**### Steering の配置と役割

- 配置場所:`steering/`
- Steering は参照・ガイド目的であり、仕様の本文は記載しない
- Steering と spec の内容が矛盾する場合、**spec を正**とする

Copilot は、コード変更や判断を行う際に  
Steering を「行動ルール」、spec を「判断根拠」として扱うこと。

---

## ADR(Architecture Decision Record)運用ルール

- 配置場所:`docs/adr/`
- **意思決定の履歴は上書きしない**
- 判断が変わった場合は **新しい ADR を追加**し、旧 ADR を Superseded にする

### ADR を書くべきタイミング
- 複数の選択肢から 1 つを選んだとき(非自明な設計選択)
- トレードオフを受け入れる判断をしたとき
- データモデル・公開インターフェースを変更したとき
- 将来の制約や負債を意図的に受け入れたとき

---

## SSOT の分割ルール(requirements / design / tasks)

本プロジェクトでは、SSOT の可読性と更新容易性を維持するため、  
要件・設計・タスクは **分割管理**を前提とする。

### 分割の目安(上限)

- requirements:1ファイル **500行**を超えたら分割を検討する
- design:1ファイル **1500行**を超えたら分割を検討する
- index は導線に徹し、原則として **200行以下**を維持する

分割後も SSOT は `spec/` に集約し、他の場所に同等の仕様本文を複製しない。

---

## EARS 記法ルール(requirements)

各要件は識別子付きで、以下のパターンを用いる。

### パターン
- **常時要件**  
  `The <system> SHALL <response>.`
- **イベント駆動**  
  `WHEN <event>, the <system> SHALL <response>.`
- **状態依存**  
  `WHILE <state>, the <system> SHALL <response>.`
- **例外・好ましくない状況**  
  `IF <condition>, THEN the <system> SHALL <response>.`
- **オプション機能**  
  `WHERE <feature>, the <system> SHALL <response>.`

### ルール
- MUST / SHALL レベルの表現を用いる
- 曖昧な表現を避け、テスト可能であること
- 実装方法・技術名は書かない

---

## 軽微変更の扱いについて

内部実装の整理やリファクタリングなど、  
**外部仕様や振る舞いに影響しない変更**の場合は  
requirements の更新は不要とする。

ただし、以下に該当する場合は軽微変更とはみなさない。

- 処理フローや責務分担が変わる
- エラー条件・例外ケースの扱いが変わる
- 将来の拡張性・制約に影響する判断を含む

その場合は、design の更新、または必要に応じて ADR を追加する。

---

## Copilot の振る舞いルール(必須)

### 1. 仕様が存在しない機能は実装しない
- 要件が不明確な場合は、まず requirements の案を提示する

### 2. コード変更時の必須確認
コードを変更する場合、以下を必ず確認・更新する。

- 振る舞いが変わる → requirements
- 構造・設計が変わる → design
- 作業の進捗が変わる → tasks
- 判断・方針を決めた → 新しい ADR

### 3. 仕様と実装の不整合がある場合
- 仕様を正として扱う
- 仕様を変える場合は、ADR を伴って明示的に更新する

### 4. 推測で決めない
- 不明点は明示的に不明とし、選択肢と影響を整理する
- 暗黙の判断は ADR として残す

---

## 変更完了条件(Definition of Done)

以下が満たされて初めて「完了」とみなす。

- [ ] requirements が最新
- [ ] design が最新
- [ ] tasks の進捗が反映されている
- [ ] 必要に応じて ADR が追加されている
- [ ] テストが更新・追加されている

---

## 基本方針

- **仕様 → 設計 → タスク → コード** の順序を崩さない
- 仕様は軽くてもよいが、常に存在していること
- 「あとで書く仕様」は存在しない
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?