目次

ニュース

日記カテゴリ

書庫

俗にいう詳細設計書とか処理定義とか言われたりするレベルのドキュメントなんですけれど、
それってソースコードとどこまでリンクしているべきなんですかね?むしろやることさえ書いてればいい気がしますが。

たとえばあるメソッドAとBがあるとして、その実装がほぼ同じであった場合にAとBの共通部をメソッドCとして定義し、AとBがCを呼ぶような形になったとします。
で、本来やるべきことはAとBのみであればAとBの処理が何をするべきか書くだけで僕はいいと思うんですよ。

みなさんはどう考えますか?

--追記
このメソッドCはプログラム設計の過程でまとめたprivateなメソッドで、
詳細設計、処理定義はプログラム設計の手前の過程でできる成果物だとします。
む~、条件が狭いかなぁ。詳細設計書がプログラム設計の結果も含めてのものなら書く必要がありそうだな。

 

投稿日時 : 2008年5月21日 22:20
Feedback
  • # re: [設計]詳細設計と実装はどれだけリンクする?
    επιστημη
    Posted @ 2008/05/21 22:50
    んと、Cがprivateであるなら少なくとも利用者目線では
    無いのと等しいんだから使い方説明には必要ないすね。
    詳細設計書がそれを作る人に向けて書かれるなら必要でしょけど。
  • # re: [設計]詳細設計と実装はどれだけリンクする?
    taka
    Posted @ 2008/05/21 23:17
    > epiさん
    なるほど、epiさんの考える詳細設計はその粒度なんですね。
    僕の場合、おそらくプログラム設計といわれるような部分を自分自身がやっているので処理定義というものは何をやればいいのかさえわかってればいいといった感じです。

    なのでどの工程を誰がやるのかという前提も必要でしたね。

    いま僕が前提としているのは業務SEというような人が詳細設計 or 処理定義を書いて、
    プログラマがそこから先(プログラム設計、実装)をやるといったイメージです。
  • # re: [設計]詳細設計と実装はどれだけリンクする?
    επιστημη
    Posted @ 2008/05/22 0:00
    あー。
    大枠での詳細設計:"何をする"は述べるけど、
    "どう実装する"はプログラマ任せ、と。
    ならばおそらくpublicな仕様に限るでしょから
    Cはどこにも現れませんですねぃ。
  • # re: [設計]詳細設計と実装はどれだけリンクする?
    まさる
    Posted @ 2008/05/22 9:03
    「本来は」仕様が書かれていれば、実装までは必要ないと思っています。なので、自分で詳細設計書を書く場合も、INとOUTがこんな感じ、レベルです。

    ただ海外オフショアや初級プログラマ(コーダ)にプログラムを作らせる場合は、実装レベルまで落とし込まないと大変なことになっちゃうのも事実。
  • # re: [設計]詳細設計と実装はどれだけリンクする?
    よねけん
    Posted @ 2008/05/22 9:27
    おはようございます。

    > で、本来やるべきことはAとBのみであればAとBの処理が何をするべきか書くだけで僕はいいと思うんですよ。

    その場合なら、私もAとBについての説明だけですね。

    詳細設計書には、基本設計では書かれないけれど、実装するには当たって明確に決めておかないといけないことを書きます。
    例えば、コンボボックスのような選択項目の初期選択値とか、実行ボタンクリックで行うべきチェックの内容とか、データベースからのデータの取り方とか。




  • # re: [設計]詳細設計と実装はどれだけリンクする?
    taka
    Posted @ 2008/05/22 10:05
    > epiさん
    結局は実装は誰がやる?によって変わってきますよね。
    たとえばまさるさんが書かれてますがオフショア、または初級プログラマならば実装レベルまで指示しないととんでもないものが出来てきそうですし^^;

    > まさるさん
    僕の書く詳細設計もIN/OUTの定義って感じですね。
    自分の設計で自分が作るからってのもありますが^^;

    > よねけんさん
    僕の考えてほぼ同じな感じです。
    ぶれてはいけない部分に関しては記述しておいて実装でぶれても問題ない部分は記述しない感じですね。
タイトル  
名前  
Url
コメント   

Blog 利用状況