知りたい人がいるのか分からない(調査と実地検査と蓄積と蒸留すればいいだけ)のでサラッとチラ見せ。
ねらい
「品質のために時間がかかる」のではなく、正本を1か所に集約することで品質と速度が同時に上がることを、各章の Before/After で示します。
立場別ルート
| 立場 | 推奨ルート |
|---|---|
| 経営層 | [[00_経営層向け]] → [[07_PM・情報共有]] → [[08_マスタサマリー]] |
| PM | [[00_経営層向け]] → [[07_PM・情報共有]]。ゲート前は 01・05・06 |
| SE | [[01_要件定義]] → [[02_基本設計・ADR]] → [[03_API・OpenAPI]] → [[05_テスト・QA]]。引き継ぎは 06 |
| PG | [[03_API・OpenAPI]] → [[04_実装]] |
SSOT の流れ
[!tip] PDF配布
[[08_マスタサマリー]] + [[00_経営層向け]] をブラウザ印刷(「背景のグラフィック」をオン)するのがおすすめです。
章一覧
| 章 | ノート | HTML |
|---|---|---|
| 0 | [[00_経営層向け]] | 経営層向け |
| 1 | [[01_要件定義]] | 要件定義 |
| 2 | [[02_基本設計・ADR]] | 基本設計 |
| 3 | [[03_API・OpenAPI]] | API |
| 4 | [[04_実装]] | 実装 |
| 5 | [[05_テスト・QA]] | テスト |
| 6 | [[06_運用]] | 運用 |
| 7 | [[07_PM・情報共有]] | PM |
| 8 | [[08_マスタサマリー]] | マスタサマリー |
成果物マップ(全工程)
| 工程 | 主な成果物 |
|---|---|
| 提案 |
baseline-agreements.md · 提案サマリー.html |
| 要件 |
REQ-xxx.md · customer/*.html · glossary |
| 設計 |
design.md · adr/ADR-xxx.md · C4.mmd |
| API |
openapi/**/*.yaml · bundled · Redoc |
| 実装 |
AGENTS.md · PR · 生成型 |
| テスト |
TestDesignDoc.md · traceability.csv
|
| 運用 |
runbooks/*.md · CHANGELOG
|
| PM |
open-items.md · gate-decision.md
|
各章ノート末尾に具体サンプル(ファイル名・抜粋)があります。
4. 実装
HTML版: ../04_implementation.html
[!abstract] この章の読み方
実装・PG向け。AGENTS.md が入口。PR で docs 同梱。
主な読者: PG · SE
AGENTS.md:PGの入口
# AGENTS.md(抜粋)
## 読む順
1. docs/steering/01_product.md
2. openapi/root.yaml(bundle後)
3. docs/adr/
## コーディング
- 型は生成物を正とする。手書きDTOを増やさない
- PRには docs 更新を同梱
## NEVER
- 顧客名・接続情報をコミットしない
- 仕様と無関係なリファクタを混ぜない
PRフロー(品質ゲート)
| Before(PG) | After(PG) |
|---|---|
| Slackで仕様確認 | AGENTS.mdが背景を保持 |
| 口頭仕様で実装→差戻し | OpenAPI型でコンパイル時検知 |
| AIに毎回背景を説明 | 聞き直し工数↓ |
エージェント運用:コンテキスト設計
- 読み込み順: AGENTS.md(常時)→ 対象 REQ の md のみ → 必要時 openapi の該当 path
- 一括投入しない: 全要件・全 OpenAPI を毎プロンプトに貼らない
-
推測禁止: open-items /
UNRESOLVEDを仕様確定させない - スキル vs 正本: スキルはワークフロー。仕様の正本は REQ / OpenAPI
- セッション境界: AGENTS.md・スキル更新後は新チャット推奨
## エージェントに渡す順
1. AGENTS.md
2. docs/requirements/REQ-042.md のみ
3. openapi/paths/orders.yaml(該当時)
## やらせないこと
- open-items 未解消の仕様確定
- 顧客向け HTML の手編集(MD から再生成)
AIへ渡してよい情報 / 渡さない情報
| 情報分類 | AI投入可否 | 条件 |
|---|---|---|
| 公開情報 | 可 | 出典を残す |
| 社内一般ルール | 条件付き可 | 社内許可済み環境を使う |
| 要件ID・抽象化済み仕様 | 条件付き可 | 顧客名・個人名・契約情報を除く |
| 顧客名・契約条件 | 原則不可 | 必要時は匿名化し、承認を取る |
| 個人情報・勤怠・評価 | 不可 | 用途を限定 |
| 認証情報・接続情報・秘密鍵 | 禁止 | 検出時は削除とローテーション検討 |
| 障害ログ | 条件付き可 | IP、ホスト名、顧客名、トークンをマスク |
[!warning] 情報分類で判断
便利さではなく情報分類で判断する。迷う場合は投入せず、匿名化または社内承認を先に行う。
成果物サンプル
| ファイル | 用途 |
|---|---|
AGENTS.md |
PG・エージェントの入口 |
| GitHub PR #128 | docs / OpenAPI / テスト同梱例 |
.github/pull_request_template.md |
PRテンプレ |
src/orders/ |
Vertical Slice 構成 |