第4回:詳細設計はどうするドキュか? (2/3)

【楽々デブドックを書こう!】開発☆ドキュン

【楽々デブドックを書こう!】開発☆ドキュン

第4回:詳細設計はどうするドキュか?

著者:シンクイット編集部

公開日:2008/02/22(金)

各箇所の設計図を作っていこう

「例えば建物でいえば、ここから先は詳細な設計図を書いていく部分に相当するわ。それ以前のステップに比べると、ほんとに細かい部分まで決めて、それを管理していく必要があるの。例えばデータベースと連携して動くWebアプリケーションを作るとしたら、まず何を決める必要があるかしら」

「データベースやWebサーバ、それらが動くOSとか…」

「そうね。それぞれどのソフトウェアを利用するかはもちろんだし、バージョンがいくつかも明記しておく必要があるわ。極端な例だけど、同じプロジェクトに参加している人の中で、PHP3とPHP5でそれぞれ開発すすめていて、もし出来上がったものに互換性がなかったとしたら?」

「どっちかに合わせて作りなおしです〜」

「そうね。それはもう大きな手戻りになるわ。だからあらかじめ決めておく必要があるわけよね」

「その他には、どんなものがあるんでしょうか」

「それを聞くくらいのレベルだったとしたら、また学校で…」

「(がくがくぶるぶる)」

「…というのは冗談として、少なくとも意見をあらかじめすり合わせておく必要がある部分を洗い出して、それぞれを決定しておく必要がある、ということね。例えば画面にどんなボタンをいくつ配置するかとか、その機能を明記しておかないと、個人個人で勝手な理想をもって開発をすすめていくかもしれないもの」

「それを突きあわせて、ぜんぜん違っていたとしたら…」

「つ・く・り・な・お・し」

「(がくがくぶるぶる)」

「でも、開発手法によっては『作り直していく』方法もあるので、なにがなんでもドキュメントに合わせたものを作り続けなくてはいけない、ということでもないのよ」

「そうなんですか〜。ところで、このステップでの開発ドキュメントはどんなツールで作るといいんでしょうか?」

図2:ドキュメントを記述するためのツール
図2:ドキュメントを記述するためのツール
(画像をクリックすると別ウィンドウに拡大図を表示します)

それぞれの設計図はそれぞれのツールで

「詳しくは『楽々デブドックを書こう!』の各連載を読んでもらったほうが早いのだけれど。簡単に言ってしまえば、ドキュメントに記載するべき内容を簡単に実現できて、かつ誰もが持っているはずのツールを適所で使って、できればそれぞれのドキュメントが連携できることが重要かしら」

「あぁ、だからマイクロソフトのオフィスを使うことが多いんですね?」

「そうね、その面は否定できないわね。Excelで作った表をWordに張り込んでおけば、表の修正を楽に行えるわ。図版を多様するなら画像そのものをWordに張り込んでもいいし、PowerPointでスライドにまとめておけば会議での報告が楽になるわ。さらにいえば、Projectでプロジェクトに関わる人たちのマネジメントを行って、それぞれの工程とドキュメントを関連付ける、ということもできるのよ」

「すごいですね〜」

「これくらいのことは、学校で習っているはずよ!」

「(がくがくぶるぶる)」

「じゃぁ、ここまでのおさらいとして、さっき例にあげたデータベースを使ったWebアプリケーションについて、ちょっとまとめてみなさい」

「はい。まずは仕様するデータベース/Webサーバ/OSなんかについて、使用する種類やバージョンを決定します。もちろん開発言語を何にするかも一緒に書きますね」

「(うなずき)」

「データベースに登録するデータについて、あらかじめどのようなテーブル定義についても決めておきます。これは場合によってはExcelでサンプルを作っておくといいかと思います」

「(うなずき)」

「複数台のサーバで運用する場合には、それぞれのサーバで何を動作させるかをはじめとした構成図を作っておくのも重要ですね」

「よくできました。じゃ、いよいよ開発?」

「…ですよ、ね?」

「今回は開発手法についての問題を解説します、っていったのを忘れたかしら?」

「(がくがくぶるぶる)」 次のページ




INDEX
第4回:詳細設計はどうするドキュか?
 開発一歩手前でもう一度考えてみよう!
各箇所の設計図を作っていこう
 それだけじゃできない詳細定義
開発☆ドキュン
第1回開発ドキュメントって何ドキュか?
第2回要求分析するドキュよ
第3回基本設計の“いろは”ドキュ
第4回詳細設計はどうするドキュか?
第5回テスト関連も忘れちゃだめドキュ!

人気記事トップ10

人気記事ランキングをもっと見る

企画広告も役立つ情報バッチリ! Sponsored

ClickHouse Cloudが実現した広告運用SaaS「ATOM」のデータ基盤革新、パフォーマンスを向上しながら、運用負荷とコストを削減 11月11日 6:20 AIで開発が加速する時代、品質保証はどう変わる? Tricentisが示すAIエージェント活用の実像 11月9日 6:45 悪用までの猶予が「1分」に迫るフロンティアAI時代に開発と本番を貫く脆弱性管理が必要 10月29日 8:30 欧州CRA対応とSBOM運用。AI生成コードのOSS混入問題の対策とは ――スニペット単位で検出する「FossID」「Insignary Clarity」によるSBOM運用 9月16日 6:40 PostgreSQLからTiDBへ、稼働中SaaSで進める段階的DB移行の実践と再設計への展望 9月7日 6:30 機能安全開発におけるGoogleTestの活用を支援!「Parasoft C/C++test CT」で実現する効率化&AI連携 4月14日 6:30 【CNDW2025】Grafanaが明かす「オブザーバビリティの哲学」ー最小限の労力で実用的なインサイトを得るには 1月23日 6:30 【CNDW2025】プロダクト急増に備える基盤刷新 ーウェルスナビがECSからEKSへの移行で得た知見とは 1月15日 6:30 【CNDW2025】250環境を5人で運用、構築時間は30分に ーKINTOテクノロジーズが語るインフラ基盤組織の作り方 2025年12月18日 6:30 新たな自動化で熱視線! AIエージェントの「推論能力」を支える2つのコンポーネントとは? 2025年11月28日 6:30