- PR -

プログラム設計書のベストプラクティス

1
投稿者投稿内容
sand
大ベテラン
会議室デビュー日: 2007/01/15
投稿数: 247
投稿日時: 2007-11-17 19:16
プログラム設計書に記述すべき内容について思い悩んでいます。
総勢30名くらいのプロジェクトです。

プログラム設計書をできるだけメンテしやすく、記述内容をシンプルに、Javadoc等自動生成できるもの以外の部分を書こうと思っています。
そういった場合に何を書けばいいでしょうか？
フローチャート（アクティビティ図）が一番なのでしょうか？
ご存知の方がいらっしゃいましたら教えていただけるとありがたいです。
そもそも製造をオフショアするわけでもないのにプログラム設計書を書く必要があるのでしょうか？
設計書を書く人とプログラムをする人が同じ場合も書く必要があるのでしょうか？
プログラム設計書を書くと実際にコーディングしているのと同じくらいの工数がかかります。
unibon
ぬし
会議室デビュー日: 2002/08/22
投稿数: 1532
お住まい・勤務地: 美人谷　　　　　　　　良回答(20pt)
投稿日時: 2007-11-17 19:32
引用:

sandさんの書き込み (2007-11-17 19:16) より:
そもそも製造をオフショアするわけでもないのにプログラム設計書を書く必要があるのでしょうか？
設計書を書く人とプログラムをする人が同じ場合も書く必要があるのでしょうか？
プログラム設計書を書くと実際にコーディングしているのと同じくらいの工数がかかります。

だれも「プログラム設計書」を必要としないのならば、不要でしょう。
ソフトウェアを売るのならば、いわゆる EXE が最低限必要ですが、普通はソースコード一式のほうがコンパイルし直しができるので良いでしょう。「プログラム設計書」がなくてもソフトウェアを売るのに支障はありません。
それとも、だれかが「プログラム設計書」をほしいと言っているのでしょうか？ならば必要でしょう。
Gio
ぬし
会議室デビュー日: 2003/11/28
投稿数: 350
お住まい・勤務地: 都内から横浜の間に少量発生中
投稿日時: 2007-11-18 04:26
引用:

sandさんの書き込み (2007-11-17 19:16) より:

プログラム設計書をできるだけメンテしやすく、記述内容をシンプルに、Javadoc等自動生成できるもの以外の部分を書こうと思っています。
そういった場合に何を書けばいいでしょうか？

ネット掲示板に書き込む前にプロジェクトメンバーと議論してみましたか?

引用:

そもそも製造をオフショアするわけでもないのにプログラム設計書を書く必要があるのでしょうか？

システムのカットオーバーが済んでから数ヶ月から数年の間、開発に携わったメンバーが誰も異動や退職することなく、設計上の決定事項をすべて記憶していられるなら不要でしょう。

引用:

プログラム設計書を書くと実際にコーディングしているのと同じくらいの工数がかかります。

設計書の抽象度や粒度、あと開発メンバーの実装スキルにもによります。
まったくの初心者が対象であれば、ほとんど実装に近いドキュメントを書く必要があるでしょう。
ベテラン相手ならば入力と出力、あとは特に注意が必要なロジックだけ指示すれば済むと考えます。
かつのり
ぬし
会議室デビュー日: 2004/03/18
投稿数: 2015
お住まい・勤務地: 札幌
投稿日時: 2007-11-18 11:41
で、何故.NETの会議室？
1

スキルアップ／キャリアアップ（JOB@IT）