ITよろづや

ITから生活の参考になる情報を備忘録代わりに残していきます

インフラで作成する要件定義書、基本設計書、詳細設計書などの考え方について

インフラエンジニアを10年以上続けていますが、仕事を進めていく上で必要な資料作成。


私は基本的に機会を触るのが好きですが、それだけでは仕事が進まない事実があり、仕事の半分以上の時間は資料作成に必要な時間になっている気がします。


では、システムを構築するまでに必要な資料とは?


これまで色んな企業で仕事をしてきましたが、基本的にはどこも大きく変わらず、以下のような資料を成果物として提供する事が多いです。

・要件定義書
・基本設計書
・詳細設計書



要件定義とは、文字通り、要件を定義していく書物です。お客様の要件をまとめ、基本設計書を作成するにあたっての要件を定義したものになります。


例えば、機器のスペックはXXX以上を用意するとか、システムの耐障害性の話とかを書いていきます。


続いて、基本設計書。


基本設計書は、詳細設計書を書く上で必要な大枠の設計を定義します。


例えば、基本設計書には細かい設定値などは書かずに、それは詳細設計書に記載します。基本設計書には、設計の方針を記載していきます。


なぜ、基本設計書が必要かと言うと、なぜこんな構成にしたのかとか、なぜ、こんな設定が入っているのかの理由が明記されているからです。


よく、時間がないからと詳細設計書(パラメータ)だけ残している場合があります。確かに、詳細設計書があれば、システムを構築する事ができますが、その値の妥当性が判断できません。


以前も、既存システムでなんでこんな値を入れているんだ?というものがありましたが、基本設計書が作成されていなかったのと、当時システムを作った人間がいなかった為、最後まで理由は不明でした。


その為、基本設計書には設計の方針やその理由を明記します。


どこまで書くかは時間や工数によりますが、可能な限りシステムで使用する機能や構成については説明があったほうがいいです。


例えば、なぜソフトウェアのバージョンの選定理由とか。例えば、ソフトウェアは最新バージョンを採用するのが一般的ですが、バグやその他の理由で最新バージョンを採用しない事もあります。


その理由を明記する事で、後からシステムの運用に入った人が、納得できますよね。理由を知らずに、そのシステムを知った人は、「どうして最新のバージョンで導入していなんだろう?」と考えると思います。


そういった選定基準は基本設計書に盛り込む事が大事だと思います。さらに、運用設計も必要ですね。どういったバックアップ手法をとるのか、その頻度はとか。


他にも監視するソフトウエアやその方法も明記してある必要があります。そして、その基本設計でっ決まった事が、実際の設定値として定義されるのが、いわゆる詳細設計書になると思います。


詳細設計書は、多くの場合、パラメータシートになる事が多いです。これは各システムの設定値を記載したものですね。

 



そして、システムが多い場合は、IPアドレス一覧などが別であると管理しやすくなると思います。基本設計書に含める事が多いですが、物理設計書と論理設計書はサイズが大きくなりそうになったら個別で作成してもOKです。


続いて、これらの資料のフォーマットですが、以下の場合が多いです。

・要件定義書:word
・基本設計書:word
・詳細設計書:エクセル
・物理設計、論理設計:visio、パワーポイント


上記はあくまで例なので、会社によって違う場合がありますが、上記のケースだったことが多いです。


設計書って作成するのは楽ではありませんが、ここをしっかりと作っておかないと、運用側に手渡す時に、トラブルになる事が多いので、しっかりと時間をとって作成する事が望ましいですね。


また、同じようなソリューションを構築する会社であれば、一度作れば、他の案件でも再利用できるので、工数の削減にもなりますね。


そして、以下にSEで参考になりそうな書籍を集めてみました。

SEのための提案書のつくり方―お客さまにわかりやすく伝える

商品の説明
お客さまにわかりやすく伝える SEのための提案書のつくり方
 顧客向け提案書を作成するに当たっての考え方やノウハウを紹介する。漠然とした問題意識はあるが具体案を持たない顧客に代わって,経営者の視点に立った提案をすることこそが提案を成功させるカギであるとする。本書では,提案の前段階となる情報収集や分析から,具体的な提案書の記法,留意すべき用字・用語,効果的な作図方法などについて広範囲に解説する。後半部(第4章)はケース・スタディとなっており,さまざまな業種の顧客を相手に,どうすれば潜在ニーズを掘り起こして効果的な提案ができるかを具体的に示している。
 

業務システムのための上流工程入門―要件定義から分析・設計まで

内容紹介
○IT業界での生き残りの道=上流SE
システム開発の仕事は大きく上流工程と下流工程に分かれるが、下流の詳細設計を担当するSEや日々プログラミングとバグ取りに明け暮れるプログラマには、「35歳定年説」といわれる年齢的な限界が立ちはだかっている。続々と登場するプログラミング言語などの新技術への対応やコスト面で、若手に対して不利な立場におかれるからだ。一方、業務システムの改善要求をどのような設計で実現すればよいかといった基本設計の部分を担当する上流SEは、新技術への対応はさほど求められない。また、企業の業務や会計の知識が必要とされる上流SEは熟練者の数が少なく、システムインテグレータ各社も人材確保に躍起になっている。やりがいもチャンスも大きいのが上流工程の仕事だ。~
 
SEの仕事は一生勉強だと思います。さらに、今の時代、工数の削減が叫ばれる中、少しでも効率よく仕事をしていくことがたいせつだと思います。特に資料作成は工数に大きく影響されるので、無駄を省き、効率よく設計書を作成する事は重要なポイントになると思います。