kkamegawa's weblog

Visual Studio,TFS,ALM,VSTS,DevOps関係のことについていろいろと書いていきます。Google Analyticsで解析を行っています

設計時ドキュメント書く?

また最近この辺の話が出ているようですね。私は書きますよ、といってもいわゆるロジックに落としこめるようなもの…日本流に言うと、詳細設計ってやつ?は書きません。

  • 何をやるか(提供する機能は何か)
  • 処理(システム)の全体図(どことどこのコンポーネントがどういう風にからみつくか)
  • コンポーネントごとにIn/Outするもの(I/Fまでは決めない。他人に渡す場合はまた別)
  • 改造するなら改造するソース(とモジュール名)
  • セキュリティ上の考慮する点
  • 改造する場合は互換性の注意点
  • 互換評価で満たすべき項目。新規なら新規で。

これを大体5ページくらいで。長くなると見づらいし、ドキュメントをモニタに出しっぱなしにしてもスクロールしないといけないし。
私の場合ひとりで最初から最後まで全部やらないといけません。そういった意味で巨大プロジェクトを仕切る人とは違うのですが、最近記憶に自信がなくなってきたので、大きな設計仕様までは特に書くようにしています。プログラムに落としこめるような詳細仕様はかいている暇がないので、ノリ(ソースを見ろ)。