【演習】実際の業務を想定して設計書をつくってみる【目的・作り方解説】

それではプログラムの内容が固まりましたので、設計に入っていきます。設計はプロジェクトを進める上でコアとなる部分かと思いますので、実際作る時に困らないように業務を想定して設計書をつくってみましょう。

設計書の目的

まず最初に設計書を作る目的を確認します。設計書はなくてもプログラムを書くことはもちろんできます。ではなぜ業務、プロジェクトでは作る必要があるのでしょうか。

1. システムの作り方を抑えるため

一つはシステムの作り方を抑えるためです。システムの作り方を設計書に落とし込むことで、設計書を読めば開発者がどう作れば目的とするシステムが完成するかが第三者視点でわかるようになります。設計書があればプログラミングができさえすれば誰でも同じようにシステムが作ることができ、質問する/される時間の削減を行えるので業務の効率化が図れる。これが設計書の目的の1つ目です。

2. システムの仕様に対する認識を合わせるため

2つ目はシステムの仕様の認識を開発側と仕事を依頼するお客さん側とで合わせるためです。1つ目の目的は開発側を意識したものですが、こちらは使ってもらうお客さんに対しての意味合いが大きいです。個人的には1.の内容よりも重要度が高いと感じます。ここがなあなあになっていると「話が違う」とか「こんなシステム依頼していない」とか目的とするシステムの開発に辿り着けず、プロジェクトが破綻しかねません。お客さんと同じ方向を向いてプロジェクトを進められるようにするための資料として設計書は重要な役割を果たします。

3. 保守、運用時など、あとから仕様を確認できるように

設計書は何も作る時だけに必要なものではありません。システムができて運用が始まった時に処理が想定通り動かないといって後でシステムの内容を調査するときにも設計書は役立ちます。また、こう動いてほしいのにそうなってない！といったお問い合わせが来たとしても設計書ではそういった仕様になってないからその動作は実現できませんなど、後からお客さんよりクレームが来ても設計書を基に言い訳をすることができます。要は自分たちを守る資料にもなるわけです。

設計書の種類

さて、設計書には様々な意味合いを持つことがわかりましたが、設計書にも多くの種類の設計書が存在します。ここでは簡単に大きく2つ分けて説明します。

基本設計書

1つ目は基本設計書です。こちらは要件定義の内容を基にシステムがどんな内容になるか説明したものになります。画面の内容や、操作方法、機能の説明など、ユーザーがシステムの概要を捉えられるように記載するものです。対象者が内部の開発者ではなく、外部のお客さんに向けて作られるので外部設計書とも言ったりします。

詳細設計書

2つ目は詳細設計書です。こちらはシステムの概要を基に、どういう処理の流れになっているか、どのようにシステムを構築するかなど、システムの開発のために、処理の詳細な部分まで定義する資料になります。対象者が内部の開発者になるので、内部設計書とも言ったりします。

設計書をつくってみる

では実際に設計書を作ってみましょう。今回は演習としてプログラムを作るための設計書を作りますが、簡単な処理のものになりますので、基本設計書として、それもプログラムの流れを把握するためのシステム概要図のみとします。開発で作るべき設計書についてはまた別の機会に解説させていただければと思いますので今回は簡単にしましょう。

なお、実際の業務でも簡単なシステムの場合は基本設計書のみ用意するということは多く存在します。ただし、その逆はほぼないと思ってもらって大丈夫です。基本設計書があっての詳細設計書です。あしからず。

システム概要図を作る

それではシステム概要図を作ってみます。システム概要図はその名の通りシステムの概要を絵的にわかるように図にしたものです。まずは概要を起こすためどんな機能があったか再度確認しましょう。

1. データの入力を受け付ける
2. 平均を求める
3. 標準偏差を求める
4. 分散を求める
5. データを出力する

上記の内容でした。これをユーザーの操作を含めてフローにしてみましょう。そうすると以下のようになるかと思います。

こんな流れになるかと思います。今回程度のシステムであればこれで概要図は完成として良いでしょう。

あとは表紙と、タイトルをつけたものをExcel等で作成して完成です。

表紙には作成者と作成日付、並びに最終更新日がわかるように項目を用意します。右下の3つの何か入れるところはここに大抵、作成者、承認者、お客さんらが名前を記載し、ハンコを押したりするのでそのためのものです。

別シートには変更履歴もわかるように用意します。お客さんの要望などで仕様変更があった場合はここに変更概要を記載し、設計書に変更を加えます。

ですので、最終的に[表紙]、[変更履歴]、[システム概要図]の3シートできていればとりあえずオッケーかなと思います。

あとは印刷したときにページの途中で切れたりしないかプレビューなどで確認して完成です。

いかがでしたでしょうか。

この記事を読んで設計書の作り方のイメージが湧いたなら幸いです。

それでは次回からはいよいよ実装に入ります。

今回はここまでです。

お疲れ様でした。