うーん・・・

プログラムの詳細設計書の内容はどの程度のレベルまで？

締切済

質問者：watanuki
質問日時：2016/10/10 16:54
回答数：2件

システム開発と運用の両方を担当しています。

最近システム開発のメンバーにアサインされたのですが、そこで作成する詳細設計書の内容には、どの程度細かく書くべきなのか疑問に感じました。
プログラムの流れをソースと同じレベルで細かく書くのか、それとも、流れ・ロジックは無視して「やりたいこと」のみを書き、コーディングはプログラマのセンスに任せるのか。（40代後半の先輩が作成する仕様書は後者でした）
詳細設計書はどの程度細かく書くべきものでしょうか？

詳細設計書を作成したらプログラマに「この設計書通り作成して」と依頼して、システムが完成すれば運用部門に「このプログラムはこんな動作するからヨロシク」と運用の引継ぎを行っています。

後々の保守を考えると、詳細設計書にはプログラムがどのように流れるのかロジックを書かなければ、保守するときに運用担当者がソースを見て解析しなければ保守できないのでは？と思います。実際、わたしが運用を引き継いだ時もそのようなケースがありました。

社内ルールや工数という観点もあるかもしれませんが、理想論や実態等をシステム開発者の方、プログラマの方、運用担当の方からご意見いただければ幸いです。

よろしくお願いいたします。

通報する

この質問への回答は締め切られました。

質問の本文を隠す

回答 (2件)

最新から表示
回答順に表示

No.2

回答者： don_go
回答日時：2016/10/10 18:12

詳細設計書で、コーディングレベルまで落とす必要は無いと思います。

＃以前、一度コーディングレベルまで落としたシステム開発に参加した
＃事はありますが..
但し、開発も運用も自社で行う様な場合には、建築でいう所の施工設計
をして、プログラムの開発・共通化をしておくと後々便利です。
・名称規約、コーディング規約を作り、それに沿って作る。
・モジュールの共通化(汎用モジュール、システム固有のモジュール)
・似通ったプログラムは同じ人に担当させる。
　一人で全てを作るのではなく、最初に作った雛形を元にして作るのも可。
　最初に作るプログラムは、しっかりとソースレビューを行う。

自分の思い通りに好き勝手にプログラムを作るのが好きだ、コーディング
能力の高さを自慢したくて、解析が難しいプログラムを作りたいと思って
いるプログラマーは少なくありませんが、趣味で作るのではなく工業製品
としての製品サイクルの事を考えると、製造過程の標準化は重要になって
くると思います。