KEEL

要件 · 最重要

1. 要件定義

MD+Mermaid正本とレビュー用HTML。サンプル画面付き。

主な読者: 経営PMSE
経営層投資対効果とリスク低減の判断材料。全文読む必要はなく、KPIとBefore/Afterで十分。
この章 レビュー用HTMLで合意速度
PM合意・スコープ・未決の管理。正本が1か所なら炎上の早期検知と説明責任が楽になる。
この章 要件IDと未決管理
SE構造・IF・例外の設計品質。MD+Mermaid+OpenAPIでレビューとAI支援の精度が上がる。
この章 Mermaidでモレ検出
PG実装の迷いが減る。AGENTS.md・型生成・PRテンプレで「聞き直し」工数が減る。
この章 受入条件の明確化

推奨モデル:社内MD + レビュー用HTML

社内正本 Markdown + Mermaid 要件ID / 用語集 Git差分レビュー SE · PM · AI 生成 合意レビュー 静的HTML / プロト 読み会・指差し確認 合意証跡 経営 · 依頼者側

正本は常に Markdown + 要件ID + Mermaid。経営・依頼者側向けにはそこから読みやすいHTMLを生成し、読み会で合意します。HTMLを正本にしないのがポイントです。

具体例:Before / After

サンプル:Excel管理(Before)— 探し物・版乱立
要件定義_v7_担当者修正_最終版.xlsx
最終版_本当
コピー (3)
???
シート12 画面
差分不明
メール添付
用語「注文」
「受注」と別義?
口頭合意
サンプル:Git + Markdown(After)— 差分が見える
diff --git a/docs/requirements/REQ-042.md
+ ## REQ-042 受注キャンセル
+ - 用語: 「受注」(Order) ※ glossary参照
+ ```mermaid
+ flowchart LR; A[申請] --> B[承認] --> C[在庫戻し]
+ ```
+ 合意確認: 2026-06-10 HTMLレビュー済
サンプル:合意確認用レビューHTML(イメージ)
REQ-042 受注キャンセル — ご確認用

■ 業務フロー(抜粋)

申請
上長承認
在庫戻し

■ ご確認いただきたい点

例外:出荷済みの場合は返品フローへ

正本: docs/requirements/REQ-042.md · 版 2026-06-10

要件MDサンプル(社内正本)

---
id: REQ-042
status: CONFIRMED
depends_on: [REQ-010]
terms: [受注, Order]
---

# REQ-042 受注キャンセル

## ユースケース
担当者が受注をキャンセルし、在庫を戻す。

```mermaid
flowchart TD
  A[キャンセル申請] --> B{出荷済み?}
  B -->|No| C[在庫戻し]
  B -->|Yes| D[返品フロー REQ-055]
```

## 受入条件
- [ ] 未出荷は在庫が戻る
- [ ] 出荷済みは返品フローへ誘導

合意ログ(サンプル)

合意ログ — REQ-042 の記録例
項目
対象要件REQ-042 受注キャンセル
確認日2026-06-10
確認方法レビュー用 HTML 読み会
合意範囲未出荷時のキャンセル、在庫戻し
未合意・確認待ち出荷済み時の返品フロー連携
次回確認日2026-06-17
証跡議事録ID、HTML版、参加者、確認コメント
合意済みと未合意を同じ資料に混ぜない。未合意は open-items.md に残し、AI や実装者が確定仕様として扱わないようにする。

効率と品質が同時に上がる理由

立場別の品質・効率メリット
立場品質効率
PM未決・曖昧語をID単位で追跡レビュー用HTMLで読み会1回で合意が進む
SEUC・フロー・用語が連動AIにMDを渡してレビュー下書き
経営スコープ外が明示される後工程の炎上コスト低減
例: reference/glossary-*.md と要件定義ゲートの曖昧語スキャンを併用する想定です。

三層モデル:MD 正本 · レビュー HTML · YAML 索引

第1章の「社内 MD + レビュー用 HTML」に加え、実運用ではYAML 索引を第三層として持ちます。人間は MD/HTML を読み、AI とゲートは索引経由で REQ・未決・トレーサを追います。

Markdown 正本 REQ · notes · ADR 抽出 knowledge/*.yaml 索引 · source_refs 参照 AI · ゲート · レポート トレーサ · 抜け漏れ
レイヤ別の役割
レイヤ読者正本か
Markdown 正本docs/requirements/REQ-042.mdSE · PM · 実装者はい
レビュー用 HTMLoutput/review/REQ-042.html経営 · 依頼者側いいえ(生成物)
YAML 索引knowledge/requirements.yamlAI · ゲート · レポートいいえ(索引)

索引エントリの必須観点(starter_kit)

requirements.yaml 等の標準項目
項目用途
source_refs根拠 Markdown への参照path · section · quote
statusdraft / review / confirmedopen-items 未解消は draft のまま
confidencehigh / medium / low推測は必ず low
relatedREQ ↔ 業務ルール ↔ 未決 ↔ リスクtraceability.yaml と整合
作業手順: extract_knowledge_from_markdown.mdvalidate_knowledge.mdレポート確認baseline-open-items.mdopen_questions.yaml は同期維持。

この工程で使う AI(要件定義)

要件 — 起草と別目レビューの分離
役割ツール例優れている点典型用途
起草・構造化Claude · Cursor · ChatGPTユーザーストーリー・受入条件の草案、ギャップ分析REQ-*.md 初稿、Mermaid フローたたき台
品質ゲートrequirements-definition-gate スキル曖昧語スキャン、トレーサビリティ着手前ゲート、open-items.md 更新
多エージェント監査ai-requirements-factory 型起草者≠レビュアーで見落とし相関を下げるINVEST / 品質チェックリスト
レビュー用HTML生成スクリプト + LLM正本MDからレビュー用静的HTMLを再生成読み会資料(HTMLは正本にしない)
MetaCTO 調査では要件工程の AI 採用率が高く、仕様の曖昧さを開発前に摘出する用途が中心(SDLC工程別マップ)。

成果物サンプル一覧

実際のプロジェクトではファイル名・パスをテンプレに合わせてください。以下は掲載可能な具体イメージ(HTML/CSS埋め込み)です。

docs/requirements/REQ-042.md
要件正本(社内)
REQ-042.md
1---
2id: REQ-042
3status: CONFIRMED
4# REQ-042 受注キャンセル
5## ユースケース
6担当者が受注をキャンセルし在庫を戻す
7```mermaid
8flowchart TD ...

SE/PMが編集・レビューする正本。

REQ-042-flow.svg
業務フロー図(Mermaid出力イメージ)
キャンセル申請 出荷済み? 在庫戻し 返品 REQ-055 Mermaid → レンダリングイメージ(REQ-042)

画像化せずMD内にソースを保持。

docs/review/REQ-042_review.html
合意確認用レビューHTML
file:///review/REQ-042_review.html

REQ-042 受注キャンセル — ご確認用

申請承認在庫戻し
例外:出荷済み → 返品フロー(REQ-055)

合意欄: □ 承認 □ 要修正(コメント:________)

読み会で指差し確認。正本はMD。

reference/glossary-index.md
用語集(抜粋)
用語集インデックス(抜粋)
用語定義類似語との違い
受注Order確定状態見積とは別
キャンセル受注の取消返品は出荷後
reference/baseline-open-items.md
未決事項一覧
未決事項(open-items)一覧
ID内容担当期限
OI-12返品時の送料負担PM6/20
OI-15在庫戻しタイミングSE6/18

オンボーディング — 要件コース B(確認テスト・演習)

所要 15分(演習)+ テスト 5分。正解 4/5 以上でコース B の知識確認完了。

演習 — 曖昧語の指摘(10分)

次の要件文の問題点を指摘し、書き直し案を1行で述べよ(Bender 曖昧性レビュー / scan_ambiguous_words.py 接続)。

#要件文(問題あり)あなたの指摘
1「システムは高速に応答すること」
2「必要に応じて適切な通知を送る」
3「ログは適宜保存する」

模範: 測定可能な閾値・主体・条件の欠如。例: 「API p95 < 300ms」「エラー時に Slack #ops へ」。

確認テスト(5問)

#問題正解の要点
1正本はどこかdocs/requirements/REQ-*.md(HTMLは非正本)
2未決事項を推測で確定してよいかいいえ → open-items
3曖昧語スキャンのタイミングゲート前・週次
4REQ-ID の目的トレーサ・変更追跡
5依頼者向け HTML の位置づけレビュー用・正本ではない
演習後: starter_kit/docs/requirements/REQ-TEMPLATE.md から REQ-001 を起票し、$dev-docs-gate-lite を実行。

関連リンク

この章とセットで読む・使う
リンク用途
基本設計次工程
PM・未決open-items
Knowledge REQREQ 索引
スターター REQ起票テンプレ
ゲートスキル曖昧語・着手判定
KEEL