第1回:開発ドキュメントって何ドキュか? (3/3)

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

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

第1回:開発ドキュメントって何ドキュか?

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

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

開発フェーズに沿ったドキュメントを作れ!

「私たちががんばれば、この人たちもおうちに帰れるんですね!」

「そうね。もちろんそのためには、どんな開発ドキュメントを作ればいいかを学ぶ必要があるわ」

「…あの地獄をこの人たちにも(がくがくぶるぶる)」

「今この人たちにもっとも必要なのは、今必要な開発作業は、どのような設計と仕様で行うべきかをまとめたドキュメントね。みんなの意識統一もできていないし、何をするべきかが明確化されていないことが問題よ」

「まずはそれからですね!」

さっそくドキュメント作りに乗り出そうとするA奈をB乃が引き止めた。

「こらこら『まずは』じゃないわよ。開発ドキュメントが必要な人、さっきなんといったかしら?」

「…開発する人と、開発を依頼する人です」

「そう。何をすべきかを明確化するには、何が必要だと思う?」

「…開発を依頼する人が、何をしたいかです!」

「その通り。開発を依頼する人が何をしたいという要求を確認できてから、はじめて開発する側の要件が決定するの。この人たちはきちんとその確認を取らずに開発をはじめて、次から次へと新しい要求をされてこの状態になった、というわけね」

「…かわいそうですね」

「ある意味ではかわいそうだけど、最初から手順を踏んで開発ドキュメントを作って確認していれば、こうはならなかったはずね」



各フェーズで必要な開発ドキュメントは?

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

「それは学校で習ったはずよ。よく思い出して説明してごらんなさい」

「え〜っと、え〜っと。まず開発を依頼する側、顧客の要望を聞きます」

「そこで作るドキュメントはどういうものかしら?」

「要求をまとめるので…『要求定義』です!」

「そうね。じゃぁ次に必要なのは?」

「要求された内容を、どのようにシステム化するか、システム化に必要な要件をまとめた『要件定義』ですね?」

「そう。そのとき要件確認書や提案書を作って、顧客に説明して了承してもらうことが重要よ」

「はい。要件がまとまったら、設計に入ります。最初は『外部設計』をして、各担当者の意識合わせを行います。その後で実際の開発プロセスに入るんですが、そこでは『詳細設計』や『仕様書』作りを行います!」

「はい、正解。そのほかにも重要なものがあるんだけど、覚えているかしら?」

「…そこまでで開発は進められると思うんですけど。何かありましたっけ?」

「開発したら、それで終わり?」

「納品します!」

「作っただけで? ほんとに?」

「…でも納品しないとだめですよね?」

「もう一回学校?」

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

「ちゃんとシステムが動作するかテストをしないとね。『テスト仕様書』が必要よ。それに納品するには『運用マニュアル』もつくらなきゃ」

「…忘れてました(泣)」

「まぁいいわ。次回からは各フェーズに沿って、作成するドキュメントの内容を詳しくみていきましょう。それでプログラマのみなさんもこんな惨状から抜け出せるでしょう」

「は〜い!」

ナレーション「はじめて開発現場の悲惨さを目の当たりにしたA奈。はたして一人前の開発ドキュメントの妖精さんになれるのか! しかしそんなに学校が怖いのか? 次週『要求分析するドキュよ』でどっきゅドキュ!」 タイトルへ戻る



INDEX
第1回:開発ドキュメントって何ドキュか?
 妖精さんと学ぶ開発ドキュメント
 開発ドキュメントとは何か!?
開発フェーズに沿ったドキュメントを作れ!
開発☆ドキュン
第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