要件定義書
機能要件・非機能要件の整理。すべての出発点。
顧客の要望をすぐ可視化
もう持ち帰って検討する必要はありません
「こういうシステムが欲しい」と書くだけで、要件定義から機能・DB・API・画面・テストまで設計書10種が揃います。そのうえで、文書どうしの食い違いまで洗い出します。
エンジニアでなくても仕様は書けます
お預かりするのは、要望を書いた文章と参考資料だけです。そこから下の10種を、上流から順に作ります。エンジニアが白紙から書き起こす工程が、出来上がったものを読んで直す工程に変わります。
機能要件・非機能要件の整理。すべての出発点。
機能ごとの詳細と、画面・テーブル・APIの対応表。
テーブル定義、列、型、制約。
エンドポイント、リクエスト/レスポンス。
画面IDと画面名の台帳。
画面ごとの表示項目・操作・遷移。
フローチャート形式で生成し、ブラウザ上で描画。
HTML DSLのワイヤーフレーム。
機能単位の検証項目。
DL時に結果記入欄を付与業務の流れに沿った通しテスト。
DL時に結果記入欄を付与適当な順番で作っているのではありません。上流の文書を材料にして下流を作るため、生成順は依存関係そのものです。タイルの左肩の番号が、この依存の段です。同じ番号の文書は並行して作られます。前提が揃っていない文書は生成できません。
ダウンロードは Markdown / PDF / Excel。ある時点の10文書をまとめてZIPで取得することもできます。
まだ言葉や文章で合意形成していますか?
文章の設計書だけを見せられても、思っていたものと合っているかは分かりません。画面を見ながらであれば、どこが違うのかをその場で指さして言えます。画面遷移図を見ながら「この導線、逆では」。画面構成図を見ながら「この項目が足りない」。実装が始まる前に潰せます。
言葉で合意しても、認識のズレは残ります。それが表に出るのは、たいてい実装が進んだあとです。画面を見て合意しておくと、その確認が打ち合わせの段階に前倒しになります。
直すコストは、工程が進むほど跳ね上がります。仕様書を読んで気づけなかったことも、画面を見れば「ここは違う」と言えます。専門知識は要りません。使う場面を思い浮かべながら見れば十分です。
打ち合わせの中で画面イメージを出せていますか?
持ち帰って数週間後に見せる、ではありません。画面のつながり方と、各画面の見た目までをその場で作って、一緒に見ながら直せます。
生成が終わった時点で、ブラウザ上にそのまま表示されます。
まだ画面をツールで書いていますか?
あるプロジェクト1件での実測です(分:秒)。所要時間は処理の混み具合で変わります。短くなることも、当日中に出ないこともあります。詳しくは最後の「世の中に万能はありません」をご覧ください。
一貫性を正確に保てていますか?
手戻りの元になるのは、1冊の中の誤りより、文書をまたいだ食い違いです。画面仕様書が使うと書いたテーブルが、DB設計書に無い。機能仕様書が参照するAPIが、API設計書に無い。1冊ずつ読んでいる限り見つかりません。
機械的に判定できるものはAIを使わずに確かめます。同じ文書なら、何度実行しても同じ結果になります。
確かめられなかった範囲は「検査不能」として件数つきで表示します。黙って除外すると、確かめていない範囲が「問題0件」に紛れてしまうためです。
意図した部分だけを直します
指摘が見つかったとき、文書全体をAIに書き直させると、直したかった箇所と一緒に、合意済みの記述も静かに変わってしまいます。指摘のあった箇所だけを作り直し、残りはそのまま使います。
直したい3件のために、無関係な85件が静かに変わる。
3件だけを作り直し、85件は一字一句そのまま。修正後、機械的に再検査。
修正対象の項目意図せず書き換わった項目そのまま保持された項目
作り直す範囲が狭いぶん、AIに処理させる量も少なくて済みます。文書全体を生成し直すより、必要な箇所だけを作り直すほうが効率が良いということです。
版はすべて残ります。上書きはしないので、いつでも前の版と見比べて、必要なら戻せます。
要件管理、構成管理、まだ人で行っていますか?
設計工程の管理は、大きく「調整」「確認」「判断」の3つに分かれます。このうち前の2つは、この仕組みで解決します。
割合ではなく、担い手の内訳です。「確認」だけが両方にまたがります。
| ドキュメント種別 | 状態 | 前提 | |
|---|---|---|---|
| 要件定義書 | あり | 生成対象外 | |
| 機能仕様書 | あり | ||
| DBテーブル設計書 | あり | ||
| API設計書 | 未作成 | ||
| 画面一覧 | 未作成 | ||
| 画面仕様書 | 未作成 | 前提の API設計書 が未作成です | |
| 画面遷移図 | 未作成 | 前提の 画面仕様書 が未作成です | |
| 画面構成図 | 未作成 | 前提の 画面仕様書 が未作成です | |
| システムテスト仕様書 | 未作成 | 前提の 画面一覧 が未作成です | |
| シナリオテスト仕様書 | 未作成 | 前提の 画面遷移図 が未作成です |
前提が揃っていない文書は、そもそも選べません。押せない理由は「前提の API設計書 が未作成です」のように、不足している文書名で表示されます。
どの文書が何を前提にするかは、システムで決めてあります。担当者ごとに解釈が違う、ということが起きません。
判断は、あえて残しています
調整と確認を引き取っても、意思決定は人の仕事として残ります。これは機能が足りないからではなく、そう設計しているからです。理由も含めてお伝えします。
| 人が受け持つこと | なぜ仕組みに渡していないか | 実際の運用 |
|---|---|---|
| いつ始めるか | 作成・確認・修正はそれぞれ費用が発生するため、意図的につないでいません。作ったら勝手に確認まで走る、という作りにはしていません | 担当の方が画面から実行します |
| どこで止めるか | 指摘が0件になるまで繰り返す作りにしていません。どこまで直すかは、納期と品質のバランスをとる業務判断です | 指摘の残り件数を見ながら、打ち切りを決めていただきます |
| どれを確定版にするか | 版はすべて残す作りで、上書きしません。どれを正とするかを自動で決めると、意図しない版が確定してしまいます | 名前をつけて固定でき、必要ならその時点に戻せます |
| 自動で直せない指摘への対応 | 確認できなかった箇所や、根拠が示せない指摘は、思い込みで書き換えないようにしています | 件数と理由が表示されるので、内容を見て対応していただきます |
| 体制と権限の決め方 | 1つのプロジェクトに1人の持ち主という作りで、複数人で権限を分ける仕組みがありません | チームで使う場合の運用ルールは、別途決めていただく必要があります |
置き換えたのは段取りと状態の把握であって、意思決定ではありません。そこは人の仕事として残しています。
正直にお伝えします
要望を話すところから画面が出てくるまでを、実際のプロジェクトでご覧いただけます。お手元の要望でお試しいただくことも可能です。
デモのお申し込み先は配布時にお伝えします
想定するプロジェクト規模での費用感、運用体制、既存の設計プロセスへの組み込み方をご相談ください。
問い合わせ先は配布時にお伝えします