第3回:基本設計の“いろは”ドキュ (3/3)

開発☆ドキュン

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

第3回:基本設計の“いろは”ドキュ

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

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

要求定義もまとめてドキュメントに!

「じゃぁどうすれば良いんでしょう?」

「だから、開発ドキュメントが必要なのよ」

「?」

「要求定義の部分で触れたことだけど、要求に基づいた確認書を作って依頼者側に承認してもらう必要がある、っていったわよね?」

「はい」

「開発ドキュメントの多くは、その『確認・承認』のプロセスを円滑に進めるためのものだし、後で『話が違う』ということの発生しないために作るの。これこれこういうシステム規模で、こんなユーザインターフェースで、外部との連携の有無、納品後の運用サポートなどなど、『どんなシステムをこれから開発します』という部分をはっきりさせるために使われるのね」

「はいはい」

「『はい』は1回!」

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

「で、はっきりさせるための資料として開発ドキュメントを書くんだけど、ここで必要なのは『開発に必要な要件』と『スケジュール』の2つに大別できるわね。場合によっては『コスト別の構成』みたいな資料もあるといいかしら」

「…難しいですね」

「それをやるのが、あなたの仕事よ」

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

「このタイミングで作る資料は主に依頼者側に承認してもらう必要があるので、提案書のような形でまとめるとよいわね。これでいよいよシステムの本開発が進められるわ」

「そうですね! ここからはプログラミングの妖精さんの出番ですね!」

「(※ためいき※)本当に学校に戻ってもらおうかしら」

「(がくがくぶるぶる)なんでですか〜?」

図3:要件定義でも承認は必要
図3:要件定義でも承認は必要

「じゃぁこういうのを作ってね」のレベルにするには?

「『こんなスペックで動作する、こんなプログラムを作ってね』で、全部プログラマの人たちに丸投げするの?」

「だって、それがプログラマさんたちの仕事ですよね?」

「だれか1人がプログラミングするなら、100歩ゆずって、それでもいいかもしれないわね。でも何十人単位のプロジェクトだったとしたら、ここで作ったレベルの資料で分担も決めず、それぞれのコードの連携もわからない状況で、何ができるの?」

「でもでも…」

「少なくとも、この部分は誰が担当して、どのように開発を進めるのかといった資料は別に必要ね」

「じゃぁそれも要求定義にいれちゃえば…」

「その情報、いちいち依頼者に承認してもらわなくちゃいけないかしら?」

「…なくてもいいですね」

「そう。ここからがようやく『開発者側』のドキュメントになるのよ」

「まだまだ先は長いんですね〜」

「そうね。ここで大きな問題を生んでしまうのが、開発手法によってドキュメントの作り方がまったく違ってくることなのよ」

「そ、それってどういうことですか!?」

「開発手法別のドキュメントの作り方については、もう説明するスペースがないの。だからそれは次回ね」

「は〜い、わかりました!」

ナレーション「まだまだ先は長い、システム開発における『開発ドキュメント作成』。この長い道のりにA奈はついて行けるのか!? そして開発手法がどのようにドキュメント作成に関わってくるというのだろうか。この続きは、次週『詳細設計はどうするドキュか?』でどっきゅドキュ!」 タイトルへ戻る



INDEX
第3回:基本設計の“いろは”ドキュ
 ちゃんとわかって書いてます?
 使う人はだれ?
要求定義もまとめてドキュメントに!
開発☆ドキュン
第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