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

質問

僕は新人SEです。
今、上司の方からあるシステムの基本設計書・システム設計書・プログラム設計書を作り、プログラミングまでしてから単体テスト・結合テストもやるように言われています。(全て１人で)

おそらく経験のある方ならすぐにできてしまうようなシステムで、上司の方も勉強のために全てやらせているようです。

今、基本設計書・システム設計書まではなんとかできて、プログラム設計書の作成に取り掛かりたいのですが、初めての経験で実際のプログラム設計書には何をどのように書いているものなのかも全く見当もつかずにいるので全く何も書けません。

上司さんは今週忙しいようで
「来週見てあげるから自分で調べたりしてやってみて」
と言っています。
ですが、全く何もできずにいるのもイヤなので何かそれらしいものでも書いてみたいのですが…プログラム設計書とは何をどう書いてあるものなのでしょうか？

日本語が書いてあるのかプログラムが書いてあるものなのか…
そういったところからわからないので少しでも何か教えていただきたいです。
宜しくお願いします。

回答No.2

boo_boo_suu · ベストアンサー

こんにちは。
No.1様のご回答通りなのですが会社によって異なります。
というのを踏まえた上で・・・うちではという回答になりますが

・日付　2009/10/10
・版　初版（その後バージョンアップで改定するため、改定ナンバー必須）
・タイトル　企業情報印刷（ここでは決定済み名称）
・発注仕様書ナンバー（正式にお客さまと契約で決めた発注番号を記載）
・作成者　boo_boo_suu
・使用言語　Visual C++
・使用データベース　ORACLE
・使用帳票アプリケーション　Crystal Reports
・フロー図（Visioで埋め込み図）
・概要説明　
メインメニューから呼び出され企業情報の印刷条件を入力し、クリスタルレポートの帳票情報から企業情報ファイル（KIGYOU_INFO）ファイルを呼び出し印字します。
・全企業情報が一覧で印字可能である。
・特定一企業（企業コード指定）での印字も可能である。
・一企業が指定された場合は企業情報を画面表示する。

-----------------------------------
で・・・・プログラム仕様書はこのくらい。
命令書ですからコードそのものは打ちません。
これみて作ってもらわないといけないので日本語メインです。

あとはDBの仕様書をみてもらったりしてプログラムのローカルルール、画面サイズ、文字サイズ　プロシージャ定義やら定数や変数、フォーム、構造体定義書などプログラム書くときの決まりごとに添ってPGさんに打ってもらっています。
一応、図とかつけてみました。(^-^;;
全体の雰囲気はこんな感じだとご理解いただければ幸いです。
ではでは～。

お礼

ありがとうございます！
とてもわかりやすくて、画像まで載せていただいたのでとても参考になりました。
頑張ってやってみます。

回答No.1

neKo_deux

明確な定義は無いし、記載する項目も会社やプログラムの作成基準ごとに異なります。
自社の製品の基本設計書・システム設計書・プログラム設計書があるのなら、そちらを参考にするのが良いです。

自分の会社では、プログラム設計書というものは無く、上流の工程から順に、システム設計、基本設計、詳細設計とかです。
必要ならば、途中に概要設計とか。

それだって、相手先の会社や組織での呼称や要求が異なるのなら、そちらに合わせて書きます。

--
> 実際のプログラム設計書には何をどのように書いているものなのかも全く見当もつかずにいるので全く何も書けません。

設計書を書くコツとしては、設計書はその後作成するテスト項目、テスト仕様書の元ネタになります。
結果的に、テストで設計内容を100%網羅できれば、それは良いプロジェクトだったって評価になります。
従って、テストできない内容を設計するのはやめた方が良いです。
あんまり意識しすぎると、仕様書というより設計条件を羅列した文書とかになりがちですが。

お礼

回答ありがとうございます。
なんとなく少しだけイメージがわいたような気がします。
プログラム設計書がどういうものなのかわからないので保存してあるファイルを開いてみてもどれがプログラム設計書なのかよくわからいので質問させていただきました。
その辺りももう少しじっくり読んでみます。