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

      2017/01/08

メモを確認する男性

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

通常の開発工程は

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

と続きますよね。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ずはり、転職です!!!

「おいおい、無責任じゃないか?」と思われたかもしれませんが、良くない職場で働き続けるのはあなたの人生と能力の無駄遣いです。

ソフトウェア開発スキルのある人材って人類の中でも限られています。それに、ITが社会に与える影響は莫大です。インターネットが生まれて様々なソフトウェアが作られ、生活は大きく変わりました。これから先もますます進化していきます。

ITエンジニアは社会の発展を担っていると言っても過言ではありません。そのITエンジニアを出来る人は限られています。あなたもその一人です。

ですから、あなたが最大限に力を発揮できる職場で仕事をするべきなんです。

私も何度か転職してみて、「探せば、自分に合ったいい会社ってちゃんとあるんだな」と確信したんです。

ぜひ、あなたもそうしてください!

転職はやってみると思ってたより簡単!

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

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

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

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

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

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

地方在住や、エンジニア未経験の人にも使える転職エージェントがある!

レバテックキャリアは東京・大阪近郊のエンジニア経験者向けサービスなので、地方在住の方や、エンジニアの仕事が未経験の方には、DODAがおすすめです。

未経験の人はサポート対象外のエージェントが多いんですけど、DODAは未経験者の転職も支援してくれます。以前エンジニア未経験の友達にDODAを教えてあげた所、ちゃんと登録できて未経験可の求人を紹介してもらえました。未経験の人こそエージェントから職務経歴書の作り方や面接の仕方のレクチャーを受けた方がずっとうまくいくと思います。

DODAは全国に拠点があるので地方在住の方もご利用いただけます。

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

フリーランスになりたい方にはギークスジョブがおすすめです。人脈がなくてもギークスジョブに登録するだけで案件を紹介してもらえます。案件の希望(どんな技術を使っているか、残業が少ないこと)等も聞いてくれるので、やりたい仕事が出来ます。対象地域は東京・大阪・名古屋・福岡近郊です。

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

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

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

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

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

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

メールアドレス (必須)

相談内容

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

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

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

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

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

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

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

エンジニア未経験の方や地方在住の方には『DODA』

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

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

フリーランスになりたい人には『ギークスジョブ』

フリーランスエンジニアになるには人脈が必要と思われがちですが、ギークスジョブに登録して希望条件を伝えれば、自分に合った案件を紹介してもらえるんですよ!思ってるより全然簡単にフリーランスってなれるもんなんです。

東京・大阪・名古屋・福岡の案件を紹介してもらえます。

 - 仕事術 , ,