プログラム設計書とは?各設計書の違いと書き方をご紹介します!

ITエンジニアを目指すとなると、プログラム設計書の存在をどう捉えれば良いのかわからない場合があるでしょう。

プログラム設計書とは、実際のプログラムをどのように記述するかを書いた設計書です。

そこでこの記事では、プログラム設計書に書く項目や書き方、詳細設計書との違いなどを詳しくご紹介します。システムエンジニアを目指す方は、ぜひ参考にしてくださいね。

プログラム設計書とは?

システムエンジニアは段階ごとに設計書を作り、プログラマーに実装してもらってテストを繰り返し、プロダクトが完成します。そんなシステムエンジニアは、提案書や要件定義書、外部設計書、内部設計書、プログラム設計書、テスト仕様書を作成するフローがあります。

これらの書類にあるプログラム設計書は、実際のプログラムをどのように記述するのかを書いたものです。モジュールの動作を決定する箇所のため、プログラマーはプログラム設計書を見ながらプログラムを作っていきます。

また、プログラム設計書以外の書類は以下のような意味があります。

提案書

提案書は、クライアント側に「このようなシステムを導入したらどうか」と提案する書類の事です。

提案書はシステム導入のメリットや、導入費用、計画している今後のスケジュールなどいろいろなプロジェクト全体の要素を書きます。

要件定義書

要件定義書は、クライアント側に「このようなシステムを作ります」と合意するための書類です。

ITに詳しくない方でも、どのようなシステムなのかを理解できるように書く必要があります。要件定義書は提案書を基に作成します。

外部設計書

外部設計書は、プログラムの設計を大まかに記述した設計書の事です。クライアント側にシステムの内容を説明する書類で、主にユーザーが中心となっています。

これは、要件定義書を基にして作られます。

内部設計書

内部設計書は、外部設計書を基にして作成され、より詳しいプログラムの設計書になります。

どこからどのようなデータを取りだし、どのような形でモジュールが連携しているのかを記載することが大切です。

テスト仕様書

テスト仕様書は、実装後のテストをどのように行うかを書いた書類です。こちらの仕様書で、プログラム設計書通りに実装したプログラムにトラブルや不具合がないかを確かめます。

このように、システムエンジニアは提案書からスタートし、テスト仕様書まで一貫した流れで書類を作成します。

この中でプログラム設計書は、内部設計書を基にした実装のための設計書という役割を持ちます。一言でいえば、実装の設計書です。
どのような引数を持ち、どのような機能を持つ関数を作るのかなど、コードに近い設計書と言えるでしょう。

\ ログインしなくても検討機能が使える♪ /
新着のエンジニア案件を見てみる

プログラム設計書に書く項目

次に、プログラム設計書に書くべき項目を見ていきましょう。

プログラム設計書は実装を支持する設計書なので、設計書通りにコードを書くとプログラムが完成するのです。しかし、この仕様は会社によって違います。具体的な仕様は会社の流儀に従う必要があります。

例えば、詳細なプログラム設計書を書く必要がある会社の場合は、以下の項目を書いていくでしょう。

・変数名やクラス名、関数名及びそれらの定義など
・定数名とその意味、数値のリスト
・使用するライブラリ
・どこからデータを取ってくるのか
・その他、考えられるプログラムに関わる項目すべて

プログラム設計書と詳細設計書の違いは?

では、プログラム設計書と詳細設計書は何が違うのでしょうか。
違いをご紹介します。

その会社によって設計書の読み方に違いがあります。詳細設計書がプログラム設計書を指す場合もあれば、内部設計書を指す場合もあるのです。

本来、詳細設計と内部設計は異なるものですが、会社によっては混同している場合もあります。社内の先輩やプロジェクトの参加者に、使われている設計書が何を指しているのかをあらかじめ聞いておくことが大切です。

プログラム設計書の書き方

最後に、プログラム設計書の詳しい書き方を見ていきましょう。

Excelによる定数リスト

プログラム設計書はいろいろな項目があります。Excelによる定数リストの書き方は、以下のようになります。

【書き方例】

No|名称|値|型|クラス名|ファイル名|書式|説明

1|HOGE_HOGE|100 |int|Hoge|Hoge.Java static final int HOGE_HOGE|ほげ番号
2|HOGEN_HOGEN|1.14142|double|Hoge.Java static final double| HOGEN_HOGEN|ルート2の代わり

このように、定数リストは名称や値、説明があれば十分でしょう。しかし、ファイル数が膨大の場合はファイル名を書いたり、クラス名を書いたりすることもあります。

書式・機能・引数・戻り値の関数定義

関数定義をする場合は、書式・機能・引数・戻り値などを以下のようにプログラム設計書に書きます。

書式:boolean check_add_minus(int a,int b)
機能:引数を加算した結果がマイナスかどうかを真偽値で返す。
引数int aの意味:第一項
引数int bの意味:第二項
戻り値:true:マイナスである
戻り値:false:マイナスではない

このように、プログラム設計書を見ただけでプログラムを書けるように心がけましょう。

\ ログインしなくても検討機能が使える♪ /
新着のエンジニア案件を見てみる

まとめ

プログラム設計書の内容や書き方例、ほかの設計書との違いなどを詳しく知ることはできましたか?

プログラム設計書は、実際にコーディングするために必要なフローを書く書類です。要件を実装レベルに落とし込むという現場監督のようなイメージです。

プログラム設計の本質は、明確な意味が感じられ、簡単に理解できるレベルの単位にプログラム全体を分解することです。

そのためにも、プログラム設計書に必要なものをしっかり理解し、わかりやすい書き方を意識することが大切です。

【お知らせ】
現在、エンジニアルートではフリーエンジニアを中心とした、フリーランスの お仕事紹介、お悩み相談を承っております。


一対一のカウンセリングに基づき、
スキルやキャリアプランなどのご要望をお伺いしピッタリの案件をご提案します。
ご参画中のご相談・節税対策、適正な給与なのか知りたい、マージンを下げたいなど何でもサポートをいたします。
案件獲得までには早ければ1〜3日、平均的に2週間以内には複数案件から選べる状況になっています。
将来的な独立の相談のみでも承っております。お気軽にご登録ください。
お仕事をご要望の方は、下記バナーより新規登録をお待ちしております。非公開求人多数です。

よく読まれている記事

「技術について(開発言語/ツール情報)」でよく読まれている記事