1.3 仕様書 vs 説明書

1.3.1 読み手の違い

仕様書と説明書（マニュアル）は、どちらも「システムの振る舞い」を記述するが、読み手が異なる。

観点仕様書説明書（マニュアル）
読み手開発者、QA、顧客（技術担当）エンドユーザー
目的システムを作るためシステムを使うため
作成時期開発前開発後
技術用語使用する極力避ける
網羅性全機能を記述主要操作に絞る

1.3.2 記述スタイルの違い

仕様書の記述例
「検索条件として顧客名（部分一致）、登録日（範囲指定）、ステータス（複数選択）を指定可能とする。検索結果は最大100件を返却し、101件以上の場合はページネーションを適用する。」
説明書の記述例
「顧客を検索するには：
1. 検索画面で顧客名を入力します
2. 「検索」ボタンをクリックします
3. 検索結果が一覧表示されます
※100件を超える場合は「次へ」で続きを表示できます」

1.3.3 補完関係

仕様書と説明書は対立するものではなく、補完関係にある。仕様書から説明書を作成することで、一貫性のあるドキュメントが完成する。

フェーズ仕様書説明書
開発前作成・レビュー-
開発中参照・更新ドラフト作成
開発後保守用に保管完成・配布
参考資料
[1] IPA「ユーザーマニュアル作成ガイドライン」