システムの計画・開発・納品それぞれの段階で必要なドキュメントの種類

この記事では、システム開発の計画から開発、納品で用いられるドキュメントの種類について解説します。
システム開発においてどのようなドキュメントを用意すればいいのかわからない事業者様は、ぜひご一読ください。

システム開発の計画段階で用いられるドキュメント

システム開発をはじめるにあたって、まずクライアントは最適な提案をしてくれる受託企業を見つけなければなりません。
そのため、計画段階において用いられるドキュメントは主に提案依頼書となります。

提案依頼書

提案依頼書とは、発注者側が受注者側に提案をしてもらうために、クライアントサイドの要件をまとめた資料です。

目標や課題があり、それを解決するためにどのようなシステムを構築してくれるのか提案をしてもらいます。
その提案をもとに発注者側は受託企業を選定するのです。

提案依頼書では、具体的に下記のような内容を明記にします。

提案依頼書には、IT企業の評価がしやすい、トラブルの発生率を下げられるなどのメリットがあり、頻繁に用いられるドキュメントです。

システム開発の開発工程で使われるドキュメント

システム開発会社に依頼し、実際に開発を進めるにあたってさまざまなドキュメントが必要となります。
システム開発の開発工程で使われるドキュメントは主に4種類あります。

要件定義書

要件定義書とは、クライアントの要望に対してそれを解決するための具体的な施策をまとめたものです。
システム開発プランをクライアントに提案する際に用います。
文章は発注者側もチェックするため、わかりやすい言葉で記述されるのが好ましいです。

具体的に要件定義書には下記の内容を記述します。

基本設計書

基本設計書は外部設計の内容をまとめたドキュメントです。
主に、機能単位で何を行うのか、機能同士の関係性を定めます。
システム全体の観点で捉えて設計を行うのが特徴です。

基本設計では、下記のような内容を記載します。

詳細設計書

詳細設計書は基本設計書に記載された内容をどのように実現するのか細かい動きを決定付けます。

基本設計では「何を決めるのか」、詳細設計では「どのように実現するのか」という点で内容が大きく異なります。
基本設計書の内容をより具体化するという意味ではないので注意しましょう。

詳細設計で記載する内容は下記の通りです。

テスト仕様書

テスト仕様書は、アプリケーションテストを行う際にチェックすべき項目がまとめられた文章のことになります。

実装後に用いられるのが一般的で、単体テストだけでなく結合テスト、システムテストすべての工程でチェックすべき内容を記載します。

実際にテスト仕様書に含めるべき内容は、下記の通りです。

システム開発の納品時に用いられるドキュメント

システムの開発後、納品時にも作成しなくてはいけないドキュメントも多々あります。
主にクライアントに受け渡す際に必要となるドキュメントで、大きく2種類あります。

操作説明書

操作説明書は、その名の通りシステムの操作手順を記したドキュメントです。
画面ごとの使い方や入力の仕方などを明記します。

操作説明書があれば、ユーザーインターフェースなどがわかりやすく、システムになれるまでに時間がかかりません。
また、運用後にわからないことが発生した際も見返すことができます。

運用マニュアル

納品後に必要となるドキュメントとして、運用マニュアルも必要になります。

運用業務フローに合わせて作成されたドキュメントのことで、IT企業側だけでなくクライアントサイドも協力して作成されるケースが多いです。
運用マニュアルは、テスト完了時や運用をスタートした際に用います。

システム開発前から納品まで工程により用いられるドキュメントが違う

以上、システム開発の計画から納品までに用いられるドキュメントについて解説しました。

システム開発を成功させるためには、さまざまなドキュメントを準備しなければなりません。
そのため、資料の作成に負担を感じている方もいるのではないでしょうか。

「自社の社員では、設計書を作成することができない」
「システム開発を依頼したいが提案依頼書を作成したことがない」

という悩みで困っている事業者様は、ぜひEMEAO!にご相談ください。
実績豊富なIT企業を完全無料でご紹介します！