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

      2017/07/03

メモを確認する男性

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

通常の開発工程は

要件定義 → 基本設計(別名:外部設計) → 詳細設計(別名:内部設計) → 実装 → テスト

と続きますよね。

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

そうなってしまうには理由があります。詳細設計書はプログラムを実装するのが誰かによって、書き方を変えるものだからです。
今回は「システム開発の詳細設計で書くべき内容・レベル」を紹介します。

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

「いらないんじゃん」って思ってる人も多いと思います。
実際、詳細設計書を作らないプロジェクトもたくさんあります。
趣味でコードを書く時も詳細設計書なんて書きませんからね。

なので、詳細設計書がなくたって、プログラムを書くことは出来ます。

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

仕様を知らない人がプログラムを書く場合はしっかり書くべき

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

その結果何度も仕様確認のやりとりをすることになってしまいます。あるいは、あいまいに書かれている箇所を間違った解釈をして実装してしまうかもしれません。

作業分担をスムーズに行うためにしっかりと詳細設計書を書くべきなんです。

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

なくてもプログラムが書けますからね。

とはいえ、仕様を確認する意味で要点は書いておいた方が良い場合もあります。

書いて確認すると想定とずれてることに気が付くことがありますからね。

詳細設計の書き方のレベルは合わせるべき?

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

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

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

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

どうしても不要なドキュメントを書かなければならない場合の対処法

私なら転職します。というか、しましたw

「おいおい、無責任じゃないか?」

と思われたかもしれませんが、合わない職場で働き続けるのは人生の無駄遣いです。

会社ってホントいろいろで、社風も社員の雰囲気も様々です。会社も相性が大事で、自分に合う会社だと、職場の人間関係もよく仕事もスムーズに進んでホント快適です。

私の場合、業務システム開発 → Webサービス開発 → スマホゲーム開発と転身していったのですが、業務システム開発よりもWebサービス・スマホゲーム開発の会社のほうが自分の考えと合っていて快適でした。

業種のチェンジって難しそうに感じますが、やってみると案外かんたんでした。プログラミングの基本はどの業種でも同じですからね。

なので、自分の考えと合わないなぁと思うことが多いようであれば転職活動してみるといいと思います。いろいろな会社や仕事があることを知れて良い刺激になるはずです!

転職活動はやってみると簡単!

私自身3回ほど転職してるんですが、思ってたより簡単で、転職エージェントを使ったらあっという間でした。

エージェントが応募先候補の選出から、面接の日程調整までやってくれるので、こちらから動かなくても半分くらい自動的に進む感じで楽でした。しかも今は好景気で売り手市場なので転職するのにちょうど良い時期です。

レバテックキャリアっていうエージェントがおすすめです。

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

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

なので、レバテックキャリアのホームページ見てみてください。「ホントだ、美人じゃん♪」ってきっと思うはずです笑

地方在住の人にも使える転職エージェントがある!

レバテックキャリアは東京・大阪近郊向けサービスなので、地方在住の方には全国の求人を扱っているワークポートがおすすめです。利用者の評判がめっちゃいいのでホームページ是非見てみてください。

人脈がなくてもフリーランスになれる!

フリーランスになりたい方にはレバテックフリーランスがおすすめです。人脈がなくてもレバテックフリーランスに登録するだけで案件を紹介してもらえます。案件の希望(どんな技術を使っているか、残業が少ないこと)等も聞いてくれるので、やりたい仕事が出来ます。対象地域は関東圏です。

「派遣社員」なら正社員とフリーランスのいいどこ取り!

フリーランスになりたいけど、確定申告とかめんどくさいなという方には派遣社員がおすすめです。

派遣ってネガティブなイメージありますが、ITエンジニアの派遣社員ならやりたい仕事を選べて、給料も悪くないですし、確定申告や年金、健康保険も派遣会社が入ってくれるのでいいと思います。

私の先輩でフリーランスになった後、派遣社員になった人がいるんですが「自由かつ煩わしい手続きがなくて最高」って言ってました!パーソルテクノロジースタッフに登録するだけでかんたんに派遣社員になれます。

私(やまろう)への相談メールも募集中

転職や仕事術、勉強法等について質問や相談がありましたら、以下のメールフォームからぜひご連絡ください。
経験者から見れば簡単に解決できる相談って多いのでお気軽にどうぞ!こう書いてもなかなかメールくれる人って少ないのでホント気軽にメールしてくれると嬉しいです。

メールアドレス (必須)

相談内容

たまに間違ったメールアドレスを入力されていて返信できない場合があります。一週間経っても返信がない場合、メールアドレスを確認の上、再度送信をお願いします。

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

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

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

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

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

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

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

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

未経験の人はサポート対象外のエージェントが多い中、ワークポートは未経験者を支援し転職を成功させています。未経験の方こそエージェントから職務経歴書の作り方や面接の仕方のレクチャーを受けた方がずっとうまくいきます。

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

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

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

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

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

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

 - 仕事術 , ,