Skip to Content
コア概念SPECベース開発

SPEC ベース開発

MoAI-ADK の SPEC ベース開発方法論を詳しくご案内します。

一言まとめ: SPEC は「AI との会話をドキュメントとして残すこと」です。セッションが 切れても、SPEC さえあればいつでも作業を再開できます。

SPEC はエージェントのためのものです: SPEC は開発者が暗記したり学習したりするための ものではありません。エージェントが作業を実行する際に参照するドキュメントです。SPEC の 原理と使い方を概念的に理解していれば十分です。

SPEC は 3 つのファイルで構成されます: /moai plan 実行時に spec.md (EARS 要件)、plan.md (実装計画)、acceptance.md (受入基準) の 3 ファイルが同時に生成されます。

SPEC とは?

SPEC (Specification) はプロジェクトの要件を構造化された形式で定義した ドキュメントです。

日常的な例えで説明すると、SPEC は 料理のレシピ のようなものです。料理をするとき 頭の中だけで覚えていると、材料を忘れたり順序を間違えたりしがちです。しかしレシピを 書き留めておけば、誰でも同じ料理を正確に作ることができます。

料理のレシピSPEC ドキュメント共通点
必要な材料のリスト要件リスト何が必要かを定義
調理の順序実装の順序どの順序で進めるかを定義
完成写真受入基準完成した結果がどんな姿かを定義
「塩少々」のような曖昧な表現なしEARS 形式で明確に曖昧さの排除

なぜ SPEC が必要なのか?

バイブコーディングのコンテキスト消失問題

AI と会話しながらコードを書くとき、最大の問題は コンテキスト消失 です。

コンテキスト消失が発生する具体的な状況:

状況何が起こるか結果
セッションタイムアウト一定時間後に以前の会話内容が消える議論した決定事項が消失
/clear 実行トークン節約のためコンテキストを初期化以前のコンテキスト全体が初期化
トークン上限超過会話が長くなると古い内容からカットされる初期の決定事項が消失
翌日の作業再開新しいセッションでは昨日の会話を知らないすべての内容を再説明する必要あり

SPEC で問題を解決する

SPEC は会話内容を ファイルとして保存 することで、この問題を根本的に解決します。

SPEC の有無による違い:

SPEC なしで作業する場合:

昨日「ユーザー認証機能」について 1 時間 AI と議論したとしましょう。JWT にするか セッションにするか、トークンの有効期限はどうするか、リフレッシュトークンはどこに 保存するか…これらすべてをもう一度議論しなければなりません。

SPEC がある場合:

以下の 1 行だけで、昨日決めた内容そのまま実装を開始できます。

> /moai run SPEC-AUTH-001

EARS 形式

EARS (Easy Approach to Requirements Syntax) は要件を明確に記述する 方法です。自然言語の曖昧さを排除し、テストで検証可能な形式に 要件を変換します。

EARS は 5 種類の要件パターンを提供します。

1. Ubiquitous (常に真)

システムが 常に 遵守すべき要件です。条件なく常に適用されます。

形式: 「システムは~しなければならない」

例:

- id: REQ-001 type: ubiquitous priority: HIGH text: "システムはすべてのユーザー入力を検証しなければならない" acceptance_criteria: - "すべての入力値に対して型検証を実行" - "SQL Injection 防止のためパラメータ化クエリを使用" - "XSS 防止のため出力エスケープを実施"

日常の例え: 「運転するときは常にシートベルトを着用しなければならない」と同じです。特別な 条件なく常に守るべきものです。

2. Event-driven (イベント駆動)

特定のイベントが発生したときにシステムがどう反応すべきかを定義します。

形式: 「WHEN ~すると、IF ~なら、THEN ~しなければならない」

例:

- id: REQ-002 type: event-driven priority: HIGH text: | WHEN ユーザーがログインボタンをクリックすると、 IF メールアドレスとパスワードが有効なら、 THEN JWT トークンを発行しダッシュボードにリダイレクトしなければならない acceptance_criteria: - given: "登録済みのユーザーアカウントがあり" when: "正しいメールアドレスとパスワードでログインすると" then: "200 レスポンスとともに JWT トークンを発行" and: "トークンの有効期限は 1 時間"

日常の例え: 「インターホンが鳴ったら (WHEN)、モニターで確認して知り合いなら (IF)、 ドアを開ける (THEN)」と同じです。

3. State-driven (状態駆動)

特定の状態が維持されている間、システムがどう動作すべきかを定義します。

形式: 「WHILE ~の間、~しなければならない」

例:

- id: REQ-003 type: state-driven priority: MEDIUM text: | WHILE ユーザーがログイン状態の間、 システムはセッションを 5 分ごとに更新しなければならない acceptance_criteria: - "最後のアクティビティから 5 分経過時に自動更新" - "セッション期限切れの 5 分前に通知を表示" - "30 分間無操作時に自動ログアウト"

日常の例え: 「エアコンがオンの間 (WHILE)、室温を 25 度に維持しなければ ならない」と同じです。

4. Unwanted (禁止事項)

システムが 絶対にしてはならない ことを定義します。主にセキュリティ関連の要件に 使用します。

形式: 「システムは~してはならない」

例:

- id: REQ-004 type: unwanted priority: CRITICAL text: "システムはパスワードを平文で保存してはならない" acceptance_criteria: - "パスワードは bcrypt でハッシュ化 (cost factor 12)" - "ハッシュ化されていないパスワードがログに含まれないこと" - "データベースに平文パスワードを保存不可" - id: REQ-005 type: unwanted priority: CRITICAL text: "システムはハードコードされた秘密鍵を使用してはならない" acceptance_criteria: - "すべての秘密鍵は環境変数またはシークレットマネージャーを使用" - "コードに秘密鍵を含めないこと" - "Git コミットに秘密鍵が含まれることを防止"

日常の例え: 「鍵を玄関マットの下に置いてはならない」と同じです。してはいけない ことを明示します。

5. Optional (任意機能)

実装が推奨されるが必須ではない機能です。

形式: 「可能であれば、~すべきである」

例:

- id: REQ-006 type: optional priority: LOW text: "可能であれば、システムはログイン時にメール通知を送信すべきである" acceptance_criteria: - "メールサーバーが設定されている場合のみ動作" - "通知を無効にするオプションを提供"

日常の例え: 「時間があればデザートも作れたらいいな」と同じです。あれば良いが なくても問題ありません。

EARS 一覧

タイプ形式用途優先度
Ubiquitous「システムは~しなければならない」常に適用されるルール通常 HIGH
Event-driven「WHEN ~すると、THEN ~しなければならない」イベント反応の定義機能による
State-driven「WHILE ~の間、~しなければならない」状態維持の動作通常 MEDIUM
Unwanted「システムは~してはならない」禁止事項 (セキュリティ)通常 CRITICAL
Optional「可能であれば、~すべきである」任意機能通常 LOW

SPEC ドキュメント構造

SPEC ドキュメントは manager-spec エージェント が自動で生成します。開発者が直接 EARS 形式を覚える必要はなく、自然言語でリクエストすればエージェントが変換します。

/moai plan 実行時に 1 つの SPEC ディレクトリ内に 3 つのファイル が同時に生成されます:

ファイル役割内容
spec.mdEARS 要件定義YAML フロントマター、要件 (5 種類の EARS タイプ)、制約条件、依存関係
plan.md実装計画タスク分解、技術スタック仕様、リスク分析と緩和戦略
acceptance.md受入基準Given/When/Then シナリオ、エッジケース、パフォーマンスおよび品質ゲート

spec.md — EARS 要件

--- id: SPEC-AUTH-001 # 一意識別子 title: ユーザー認証システム # 明確で簡潔なタイトル priority: HIGH # HIGH, MEDIUM, LOW status: ACTIVE # DRAFT, ACTIVE, IN_PROGRESS, COMPLETED created: 2025-01-12 # 作成日 updated: 2025-01-12 # 最終更新日 author: 開発チーム # 作成者 version: 1.0.0 # ドキュメントバージョン --- # ユーザー認証システム ## 概要 JWT ベースのユーザー認証システムを実装 ## 要件 ### Ubiquitous - システムはすべての API リクエストに認証を要求しなければならない ### Event-driven - WHEN ユーザーがログインすると、THEN JWT を発行しなければならない ### Unwanted - システムはパスワードを平文で保存してはならない ## 制約条件 - API レスポンス時間 500ms 以内 - パスワード bcrypt ハッシュ化 (cost factor 12) ## 依存関係 - Redis (セッション管理) - PostgreSQL (ユーザーデータ)

plan.md — 実装計画

# 実装計画 ## タスク分解 1. ユーザーモデルおよびマイグレーション作成 2. JWT トークン発行/検証ユーティリティ実装 3. ログイン/会員登録 API エンドポイント実装 4. 認証ミドルウェア実装 5. Refresh Token 更新ロジック実装 ## 技術スタック - Go 1.23 + Fiber v2 - PostgreSQL 16 + GORM - Redis 7 (セッション/トークン保存) ## リスク分析 | リスク | 影響 | 緩和戦略 | | --- | --- | --- | | トークン窃取 | HIGH | Refresh Token ローテーション、HttpOnly Cookie | | ブルートフォース | MEDIUM | Rate Limiting、アカウントロック |

acceptance.md — 受入基準

# 受入基準 ## シナリオ ### AC-01: 正常ログイン - **Given** 登録済みのユーザーアカウントがあり - **When** 正しいメールアドレスとパスワードでログインすると - **Then** 200 レスポンスと JWT トークンセットを返却 ### AC-02: 不正な資格情報 - **Given** 登録済みのユーザーアカウントがあり - **When** 間違ったパスワードでログインすると - **Then** 401 レスポンスと一般的なエラーメッセージを返却 ## エッジケース - 期限切れの Refresh Token での更新時に 401 レスポンス - 同時ログイン制限を超過した場合、最も古いセッションを期限切れにする ## 品質ゲート - API レスポンス時間: 500ms 以内 (P95) - テストカバレッジ: 85% 以上

SPEC ワークフロー

SPEC 作成は /moai plan コマンド 1 つで開始されます。

実行方法:

# SPEC 作成コマンド > /moai plan "ユーザー認証機能の実装"

このコマンドを実行すると、以下が自動的に進行します:

  1. 要件分析: manager-spec が「ユーザー認証機能」が何を意味するかを 分析します
  2. 明確化質問: 曖昧な部分があればユーザーに質問します (例: 「JWT とセッション のどちらを希望しますか?」)
  3. EARS 変換: 自然言語を 5 種類の EARS タイプに自動分類します
  4. 3 ファイル生成: .moai/specs/SPEC-AUTH-001/ ディレクトリに spec.mdplan.mdacceptance.md の 3 ファイルを同時に生成します
  5. レビュー依頼: 生成された SPEC をユーザーに提示し確認を求めます

重要: エージェントが生成した SPEC ドキュメントは必ず一度レビューしてください。AI が 要件を誤って解釈したり、漏れが生じる可能性があります。特に受入基準がテスト 可能か、優先度が適切かを確認することをお勧めします。

SPEC ファイルの配置と管理

ファイル構造

.moai/ └── specs/ ├── SPEC-AUTH-001/ │ ├── spec.md # EARS 要件 │ ├── plan.md # 実装計画 │ └── acceptance.md # 受入基準 ├── SPEC-PAYMENT-001/ │ ├── spec.md │ ├── plan.md │ └── acceptance.md └── SPEC-SEARCH-001/ ├── spec.md ├── plan.md └── acceptance.md

SPEC ステータス管理

各 SPEC はライフサイクルに応じてステータスが変更されます。

ステータス意味次に遷移可能なステータス
DRAFT作成中、レビューが必要ACTIVE, REJECTED
ACTIVE承認済み、実装準備完了IN_PROGRESS, REJECTED
IN_PROGRESS実装進行中COMPLETED, REJECTED
COMPLETEDすべての受入基準を満たし、完了(最終ステータス)
REJECTED要件却下、再作成が必要(最終ステータス)

実践例: JWT 認証 SPEC

実際に /moai plan を実行して生成された SPEC の例です。

# SPEC 作成 > /moai plan "JWT ベースのユーザー認証システム。ログイン、会員登録、トークン更新機能を含む"

以下のように .moai/specs/SPEC-AUTH-001/ ディレクトリに 3 つのファイルが生成されます。

spec.md — EARS 要件:

--- id: SPEC-AUTH-001 title: JWT ベースのユーザー認証システム priority: HIGH status: ACTIVE created: 2025-01-15 version: 1.0.0 --- # JWT ベースのユーザー認証システム ## 概要 JWT トークンを使用したユーザー認証システム。 ログイン、会員登録、トークン更新機能を実装する。 ## 要件 ### Ubiquitous - REQ-U01: システムはすべての認証トークンを HTTPS でのみ送信しなければならない - REQ-U02: システムはすべてのユーザー入力を検証しなければならない ### Event-driven - REQ-E01: WHEN ユーザーが会員登録フォームを送信すると、 IF メールアドレスが重複していなければ、 THEN アカウントを作成しウェルカムメールを送信しなければならない - REQ-E02: WHEN ユーザーがログインすると、 IF 資格情報が有効なら、 THEN Access Token (1 時間) と Refresh Token (7 日) を発行しなければならない ### Unwanted - REQ-N01: システムはパスワードを平文で保存してはならない - REQ-N02: システムは期限切れの Refresh Token で新しいトークンを発行してはならない ### Optional - REQ-O01: 可能であれば、ソーシャルログイン (Google、GitHub) をサポートすべきである ## 制約条件 - パスワード: bcrypt (cost factor 12) - Access Token 有効期限: 1 時間 - Refresh Token 有効期限: 7 日 - API レスポンス時間: 500ms 以内 (P95)

plan.md — 実装計画:

# 実装計画 ## タスク分解 1. ユーザーモデルおよび DB マイグレーション作成 2. パスワードハッシュ化ユーティリティ実装 3. JWT トークン発行/検証ユーティリティ実装 4. 会員登録 API エンドポイント実装 5. ログイン API エンドポイント実装 6. 認証ミドルウェア実装 7. Refresh Token 更新ロジック実装 ## 技術スタック - Go 1.23 + Fiber v2 - PostgreSQL 16 + GORM - Redis 7 (Refresh Token 保存) ## リスク分析 | リスク | 影響 | 緩和戦略 | | --- | --- | --- | | トークン窃取 | HIGH | Refresh Token ローテーション、HttpOnly Cookie | | ブルートフォース | MEDIUM | Rate Limiting、アカウントロック |

acceptance.md — 受入基準:

# 受入基準 ## シナリオ ### AC-01: 正常ログイン - **Given** 登録済みのユーザーアカウントがあり - **When** 正しいメールアドレスとパスワードでログインすると - **Then** 200 レスポンスと JWT トークンセット (Access + Refresh) を返却 ### AC-02: 不正なパスワード - **Given** 登録済みのユーザーアカウントがあり - **When** 間違ったパスワードでログインすると - **Then** 401 レスポンス ### AC-03: 重複会員登録 - **Given** すでに登録済みのメールアドレスがあり - **When** 同じメールアドレスで会員登録すると - **Then** 409 レスポンス ### AC-04: トークン更新 - **Given** 有効な Refresh Token があり - **When** トークン更新をリクエストすると - **Then** 新しい Access Token を返却 ## 品質ゲート - API レスポンス時間: 500ms 以内 (P95) - テストカバレッジ: 85% 以上

この SPEC で実装を開始する:

# SPEC 確認後に実装開始 > /moai run SPEC-AUTH-001

このコマンド 1 つで、設定された開発方法論 (DDD または TDD) に従い SPEC のすべての要件を 自動で実装します。新規プロジェクトは TDD (RED-GREEN-REFACTOR)、既存プロジェクトは DDD (ANALYZE-PRESERVE-IMPROVE) サイクルを使用します。

SPEC 作成のヒント

自然言語から EARS への変換

日常的なリクエストを EARS 形式にどのように変換するかを比較します。

自然言語のリクエストEARS 形式
「ログイン機能を作って」WHEN ユーザーが有効な資格情報を提示すると、THEN 認証トークンを発行しなければならない
「パスワードは安全に」システムはパスワードを平文で保存してはならない (Unwanted)
「速くないとダメ」ログインレスポンス時間は 500ms 以内でなければならない (Ubiquitous)
「エラー処理をちゃんと」WHEN エラーが発生すると、THEN ユーザーに明確なメッセージを表示しなければならない
「できたらいいな」可能であれば、システムはリアルタイム通知をサポートすべきである (Optional)

EARS 形式を直接書く必要はありません。/moai plan に自然言語でリクエストすれば manager-spec エージェントが自動で EARS 形式に変換 します。上の表は どのように変換されるかを理解するための参考資料です。

関連ドキュメント

Last updated on