使い方ガイド
- 正本と生成
正本は Markdown(リポジトリ)で、SSOT(単一の真実の源)です。ハブの HTML は正本から生成する派生物で、直接編集せず、正本を直して作り直します。 検査に落ちたら配信されず、前の版が出たままになります。
- ①正本の Markdown(SSOT)唯一の真実の源。ここだけを直す
- ②生成表と図を HTML に
- ③検査ズレ・リンク・社内表記
- ④配信main に入れたら公開
- 内部用/外部用
上の切り替えで、作業ハブ(全件)と AI レビューハブ(お客様向け)を行き来できます。 どちらも同じ正本から生成した同じページで、文書を作り分けてはいません。 外部用は「外部」の印を付けた成果物だけを集める足し算で作り、公開前に社内向けの表記が残っていないかを自動で検査します。 各行の「外部 ↗」から、外部用の同じページを開けます。
- 配信先
main へのマージで、2 つとも実際に配信します。作業ハブは社内のネットワークと認証の内側にある社内用のサイト、AI レビューハブはお客様のアカウントだけが入れる別のサイトです。 お客様には社内用の URL を渡さず、お客様向けのサイトだけをお渡しします。 このデモでは、2 つのサイトの見え方を上の切り替えで見比べられます。
- 状態・合意レベル・レビューのお願い
- 状態
- レビュー可能お客様に内容を確認していただく下限
- 確定お客様と合意済み
- 内部レビュー待ち社内のレビュー待ち
- 対応中直している最中
- 仮作成済AI の初版。未検証
- 未着手まだ作っていない
- 参照資料参照用
合意レベル- チェック載せて合意をとる。合意は文書ごとに 1 回
- チェック(形式のみ)仕様書から自動で作る一覧・対応表。中身は元の仕様書で合意するので、形と載せ方だけ合意する
- 参照載せるが合意はとらない
- 載せない定例・メール・タスク管理ツールで扱う
レビューのお願い成果物には、作成の進みを表す状態と、何を合意するかを表す合意レベルとは別に、いまどの程度見ていただきたいかを表す 3 段のラベルを付けています。レビューの必要性が高いものほど、はっきりした色にしています。合意レベルが「参照」のものと、状態が「参照資料」のものは、参照用です。
- レビュー対象30 件内容のレビューをお願いしたいものです(画面遷移図から開く画面モックを含みます)
- 一部レビュー対象2 件全体ではなく、成果物の下に添えた「ここだけ」の部分について、レビューをお願いしたいものです
- 参照用13 件気になったときに開くものです(レビューの対象ではありません)。成果物の下にレビューの場所を添えているものは、その内容のレビューをそちらでお願いします
- 探し方
⌘K / Ctrl+Kで成果物を検索。幅 1200px 以上では、右のジャンプパネルからグループへ移動できます。
「仮作成済」の 39 件は AI の初版で未検証です。お客様に見せる前に内部レビューを通してください。
- 生成物のズレ: 0 件
- ID の未定義参照: 3 件
- リンク切れ: 0 件
- 社内向け表記の混入: 1 件
警告のある成果物は、詳細ページの「自動検査」で内容を確認できます。
標準 10 種
31 件・使い続ける成果物まず 1 番の計画書・WBS で進め方と日程を確かめます。要件定義の 8 割は、2 番の画面遷移図を辿って進みます。番号の順に、計画書・WBS → 画面遷移図 → 画面モック → 仕様書 → 外部連携 → 未決事項 → 確認事項と並べています。
プロジェクト計画書・WBS
プロジェクトの進め方(プロジェクト計画書)と、作業の予定と状態(WBS)。計画書はご判断に要る点をまとめたエグゼクティブサマリーから読めます。
内容のレビューは、詳細版でお願いします
画面遷移図
まずここから要件定義の軸。ここから辿ります。画面の箱を押すと画面モックへ、モックから未決事項・外部連携へ移れます。
画面モック
画面仕様。画面イメージ・決まっている仕様・確認中の事項・使う外部連携を、画面ごとに確認できます。
変わった仕様は、各画面モックでレビューをお願いします
業務仕様書
機能(FN)と業務ルール(BR)。判定条件・数値・閾値・異常系まで書きます。
処理仕様書
機能ごとの処理(PRC)と関与システム。シーケンス図は処理の表から作ります(タブで切り替え)。
データモデル
エンティティ(ENT)・ER 図・属性・コード値。
外部 IF 一覧
IF の一覧と連携先システム、連携先ごとの連携データ項目。
API 仕様書
IF ごとの方式・認証・電文の項目・エラーと再送のサンプル。全値仮置きで、基本設計で確定します。
全値が仮置きです。連携の中身は、外部 IF 一覧でレビューをお願いします
未決事項台帳
まだ決まっていないこと(TBD)。共通と業務フェーズごとの台帳です。画面モックの「確認中」から飛べます。
問いへのご回答は、確認事項リストでお願いします
問いへのご回答は、確認事項リストでお願いします
問いへのご回答は、確認事項リストでお願いします
問いへのご回答は、確認事項リストでお願いします
確認事項リスト
お客様にお尋ねしたいこと。未決事項台帳の TBD と対応します。指摘や回答は、チケットか Excel で受けます。
付録(必要なときだけ)
22 件
一覧・索引
成果物の一覧と、成果物どうしの関連図、要件の対応表。
どの成果物をレビューしていただくかは、成果物マトリクスでご確認ください
要件ごとの機能・業務ルール・画面・IF の列に抜けが無いかをご確認ください。「状態」の列はレビューの対象外です
- 社内のみ
機能の中身は、業務フェーズごとの業務仕様書でレビューをお願いします
ワークフロー
業務フェーズごとの要件(業務フロー)。スイムレーン図へ移れます。
ユースケースと業務フロー
接点(人が EC と関わる窓口)ごとのユースケースと、業務の成果が出るまでの時間に沿って接点・人・システムをまたぐ業務フローの 2 層。ユースケースの流れはシーケンス図で、業務フローは人ごとの列で見られます。
ユースケースは「EC サイト(購入者)」の接点を、書き方の見本としてご確認ください(ほかの接点は作成中)
横断の取り決め
ロールごとの権限、全体にかかる前提・制約、用語、帳票・CSV、全画面に共通の画面の骨格。
- メッセージ一覧(基本設計で作成。いまは各業務ルールの「条件 → 扱い」でご確認ください)未着手msgチェック更新 2026-10-11外部
非機能要求・システム化方針
非機能の要求レベルと、システム化の方針。要件定義のうちに作ります(未作成のものは灰色で表示しています)。
- システム化方針書未着手policyチェック更新 2026-10-12外部
- AI 活用要件未着手ai-useチェック更新 2026-10-02外部
受領資料
お客様から受領した資料の要点。参照用で、合意の対象ではありません。
このハブについて
このハブの作り方。正本からの生成・検査・配信の仕組みと、運用の手順。
テスト仕様書
画面ごとの受入確認。開発がチェックするもの(社内のみ)。
- 商品管理未着手prd-test載せない更新 2026-09-30社内のみ
- 社内のみ
決定の経緯と考慮漏れ
社内で使う補助資料。お客様向けには出しません。
- 社内のみ
- 社内のみ
ワークフロー(業務フロー)
前提・スコープ
- 位置づけ
- 叩き台(AI の初版)を人が確かめて確定します。推測した箇所と決まっていないことは、TBD として未決事項台帳に出します。
- 入力資料
- 打合せの記録・受領した資料・既存システムの仕様。AI が仕様書の初版を作り、人が検証します。
- レビューの観点
- 人は「モレ・混入・言い回し」の 3 観点で見ます。形式(ID の未定義参照・リンク切れ・社内向け表記の混入)は機械で毎回検査します。
- 品質の考え方
- 自動検査が保証するのは「形」までです。中身が正しいかどうかの最終判断は人が行います。
- 正本
- docs/spec/md/ 配下の Markdown が正本(SSOT)で、この表は成果物一覧.md から生成します。HTML は派生物なので、直接編集しません。