システム開発の詳細設計書/内部設計書に書くべき内容・レベル

      2017/09/06

メモを確認する男性

「詳細設計書ってどこまで書けばいいのかなぁ?」
「細かく書きすぎるとコード書くのと変わんなくなっちゃうし…」
「ざっくり過ぎると足りないし…」

通常の開発工程は、

  1. 要件定義
  2. 基本設計(外部設計とも言う)
  3. 詳細設計(内部設計とも言う)
  4. 実装
  5. テスト

と続きますよね。

この中でも詳細設計は軽視されがちで、きちんと設計を終えずに実装工程に入ってプログラミングを始めることも多いかと思います。

そうなってしまうのには理由があります。詳細設計書はプログラムを実装するのが誰かによって、書き方を変えるべきものだからです。

そんなわけで今回は「詳細設計に書くべき内容・レベル」を紹介します。

そもそも詳細設計書って必要?

「いらないんじゃ…?」と思ってる方も多いかと思います。

実際、詳細設計書を作らないプロジェクトもたくさんあります。
趣味でコードを書く時も詳細設計書なんて書きませんよね。

なので、詳細設計書がなくたって、プログラムを作れます。

ですが、詳細設計書が必要なケースがあります。

設計者と実装者が違う場合は、しっかり書くべき

設計をする人と、プログラムを実装する人が違う場合は、詳細設計書がしっかりと書かれていないと、プログラムが書けません。

その結果、何度も仕様確認のやりとりが生まれます。

あるいは、あいまいに書かれている箇所を間違った解釈をして実装してしまうかもしれません。

ですから、作業分担をスムーズに行うためにしっかりと詳細設計書を書く必要があります。

設計と実装を同じ人がやる場合は、書かなくても良い

仕様が頭の中にあるので、詳細設計書を書かなくてもプログラムが書けます。

とはいえ、仕様を再確認する意味で簡易的な粗い設計書を書くのは良いことです。

設計書を書いているうちに、想定が間違っていたことに気が付くことがありますからね。

書き方のレベルは合わせるべき?

作業効率から考えると上記で述べたように、設計と実装を同じ人が行う場合は詳細設計書は粗く書いて、別の人が行う場合はしっかりと詳細に書くのが良いわけですが、そうすると、プログラムによって書き方のレベルが異なってしまいます。

大抵のプロジェクトは、設計書のレベルを合わせます。粗いレベルに合わせてしまうと、設計と実装者が違うモジュールの作業がうまくいかないので、細かく書くレベルに合わせることになります。

すると不必要にしっかりと設計書を書く工数が増えてしまいます。体裁にこだわるプロジェクトの場合はそうなりがちです。

なので、ベストなのは、納品物としての詳細設計書は書かないことにして、作業分担用のメモとして設計者が実装者へ詳細設計書を渡すというのがいいのではないかと思います。

おまけ: 給料で損した経験談

私と同じ失敗をされないよう経験をシェアしてます。

私が新卒で入った会社は社員数80名の零細ベンダーでした。

基本給は17万円で手取りは14万円くらいでした。仕事は客先常駐の業務システム開発(言語はJava)でした。

会社の先輩に「うちの会社って給料安すぎませんか?」って聞いてみたところ、

「どこもそんなもんだよ、ふつうふつう」

と言われて、「そうなのかなぁ…」と半信半疑ながら4年半勤めて年収は320万円でした…。

「やっぱ安すぎだろ!?」と思って試しに転職してみたら、

仕事内容はほぼ同じで年収が120万円もアップしたんです!

「こんなことがあっていいのか…」って感じですが、現実はどんな仕事をするかより、どの会社で働くかで給料が決まる面が大きいんですよね。

給料の高さが全てではありませんが、年収相場より大幅に安いという方は一度転職を検討してみると良いと思います。

相場がどれくらいか分からないという方はこちらの記事も、ぜひ読んでみて下さい!

エージェントを使った方が転職活動は楽です

東京・大阪近郊のイケてるIT企業に転職したい人には『レバテックキャリア』

 東京・大阪近郊のエンジニア経験者向け転職サービスです。

このサービスを運営しているレバレジーズという会社はシステム開発もやっているので、現場の仕事をよくわかってくれてますし、ヒカ☆ラボというIT系の勉強会なども主催していたりteratailというプログラマー専用の質問サイトを運営してて好感が持てます。求人案件もWebやスマホの面白い仕事が多いのでいいと思います。

ホームページを見ると分かるんですが、若くて美人の担当者が多いのもナイスなんです!私の場合(たぶんあなたも)、担当者が美人だと転職活動のモチベーションめちゃ上がりますからね笑

エンジニア未経験の方や地方在住の方にはワークポートというエージェントをおすすめします。

エンジニア未経験の方や地方在住の方には『ワークポート』

全国の求人を扱っていて、しかもITエンジニア未経験の人にも転職支援をしてくれるエージェントです。

未経験の人はサポート対象外のエージェントが多い中、ワークポートは未経験者を支援し転職を成功させています。

未経験の方こそエージェントから職務経歴書の作り方や面接の仕方のレクチャーを受けた方がずっとうまくいきます。

『派遣社員』なら正社員とフリーランスの『良いとこ取り』!

  • 「フリーランスになりたいけど、確定申告とかめんどくさいな」
  • 「定時帰りできる職場や、時短勤務がしたい」

という方には派遣社員がおすすめです。

派遣ってネガティブなイメージありますが、ITエンジニアの派遣社員なら

  • 時給が高く、給料も悪くない
  • やりたい仕事を選べる
  • 確定申告不要(派遣会社がやってくれる)
  • 厚生年金、健康保険も派遣会社が入ってくれる

ので、正社員とフリーランスのいいとこ取りな、とてもいい選択なんです。

 - 仕事術 , ,