外部設計書の書き方

「仕様書の書き方」の一連のページをまとめて電子書籍化しました。
iBookstore で発売中です。 2015.05.11

この文章や、文章中で定義する用語は、株式会社ランバーミルの開発業務の中で蓄積されたノウハウを基にしています。業界一般や書籍等で定義されているものとは、必ずしもニュアンスが一致していない点に注意して下さい（業務の参考にはなるかもしれませんが、試験対策には使えません）。

外部設計書とは

システムを外部から見た（≒ユーザとして使用した）際の振舞いを定義します。画面遷移図と各画面（≒ユーザインタフェース、以下UI）の説明が主になります。画面の説明が必要になるため、この設計書を記述するのは、UIの実装がある程度済んだ後になります。実際のUIを組み立てる前に、詳細な画面を別途イラストソフトなどで描く事は時間の無駄です（経験上、イラストでは実際のUIを100%再現できず、クライアントと共有する完成イメージに必ず齟齬が出ます。齟齬が出ないほど精巧なイラストを描くより、実際の画面モックアップを作った方が早いです）。実装時に参考にするのはせいぜい手書きのラフスケッチで十分です。外部設計書は、文字通りの設計書ではなく、システムが要件を満たしていることを確認するための一つのツールと考えましょう。

各項目の記載指針

外部設計書に必要な項目の種類は後述する２つのみです。種類は少ないですが、ユーザが触れる全てのUIに関して記述するとページ数は多くなる傾向があります。類似する遷移や画面はなるべく一括りにして説明文等に条件を付与するなど、システムの要旨を簡潔に伝えられるよう工夫するとよいでしょう（初期段階で枚数や見積金額を稼ぐために、コピー＆ペーストを繰り返した設計書を作っても後々のメンテナンスが大変です）。

画面遷移図

UMLのステートチャート図、或いはそれに類する図を記述します。各画面の呼び名と遷移の条件を明確にすることを第一義とし、詳細になり過ぎないように注意します。また、設計書はA4サイズの用紙に印刷することを想定し、一つの遷移図がA4サイズに収まるようにします（A4に収まらない遷移図は複雑過ぎて不具合の温床となりやすいです）。

画面遷移図の例

各画面の説明

上記の遷移図の中で、重要と思われるUI毎に作成します。スクリーンショットを貼り付け、ボタンやテキストフィールド等の各要素の機能を吹き出しの形で記載してゆきます。処理の流れが重要な場合は、複数のスクリーンショットを貼り付けて簡単な遷移図のように説明をすることもあります。

画面遷移図の例

外部設計書とは

各項目の記載指針

画面遷移図

各画面の説明

関連リンク