詳細設計書の書き方

質問

こんにちは。私は30代の男性です。
若干カテ違いかもしれませんが、こちらで質問させていただきます。

簡単なシステムの詳細設計書を書くように言われたのですが、初めてなのでどのように書けばいいのかわかりません。詳細設計書の書き方が載っているサイトを教えて頂けないでしょうか。もしくは「最低こういったことを書けばよい」という具合に教えて頂いても構いません。

上司から「とりあえず書くように。」とのことなので、下手でもいいので書ければと思います。

よきアドバイスをお待ちしております。
宜しくお願い致します。

回答No.1

precog · ベストアンサー

手本もなく、いきなり書けと言われてもツライですよね。

社内に以前のものがあれば、見てみることをお勧めします。どうせ、一ラウンド経験しないと、何がいいのか、何が悪いのかは判断出来るようになりません。先輩の胸を借りましょう。

で、それだけだとあんまりなので、コツを一つ、、、

過不足なくやりたいと思ったときに、わたしがいつもやってる方法は「次の工程を試しにやってみる」です。

つまり、機能設計書 (があるなら) そこからいきなりプログラムを書いてみます。コーディングに慣れて居るなら、実際に書かなくても頭の中で「試してみる」だけでも構いません。そのときに決まってないと困ること、検討しないといけないこと、設計が必要なこと、調査が必要なことが出てくると思います。それを詳細設計書に書くのです。

逆に言うと、詳細設計書は、スムーズにコーディングするための前準備を書類として整えるという意味があります。

しかし、オブジェクト指向言語など、進んだ言語を使う場合は、オブジェクト定義は詳細設計の過程で完了してしまうと思います。そのことに気がついたなら、詳細設計書は、オブジェクト定義ソースをその一部としても構いません。もちろん、コーディング中にどんどんクラス定義は増えて行きますので、詳細設計時のヘッダーファイルに拘る必要はありませんし、そのことを理由として詳細設計しなおす必要もありません。ソースコードを読めば済むことは、他に書いても構成管理でミスするだけですので。

わたしならですが、、、オブジェクト指向言語を使うなら、コーディングしてから、ツールを使って詳細設計所を出力します。コーディング出来ないような設計をしてしまったら後々面倒ですからね、、、と、これは問題児の発言ですので初心者のあなたはまじめに命令をこなしてください。(^_^;

お礼

ご回答ありがとうございます。
私はC言語を扱っています。参考にさせて頂きます。

回答No.2

noname#96518

詳細設計書の基本はフローチャートやPDSチャートをきっちりと書く事です。
それで全てと言っても過言ではないと思います。

プログラマは詳細設計書のフローチャートを見ながらコーディングするはずなので、詳細設計書が間違っていればプログラムも間違ってしまうことになります。

では頑張って下さいね。

お礼

ご回答ありがとうございます。

>詳細設計書の基本はフローチャートやPDSチャートをきっちりと書く事です。
>それで全てと言っても過言ではないと思います。

なるほどぉ。参考にさせて頂きます。