最終更新日:
設計書とは、システムが何をし、どのような仕組みで作られているかを、要件・設計・運用などの段階ごとに書き残した文書です。
システムの文書には、要件定義書、基本設計書(画面・帳票・データ・外部とのつながりなど)、詳細設計書、テストの計画と結果、運用の手順書などがあります。どの文書をどこまで作るかは、システムの大きさ、開発の進め方、保守を誰が行うかによって変わります。
文書が残っていないと、仕様を変えるときや不具合を直すときに、ソースコードを読み解く手間がかかり、担当が替わったときの引き継ぎも難しくなります。アジャイル開発のように文書を少なくする進め方でも、保守に要る情報は残しておく必要があります。
発注する側は、納品物にどの文書を含めるか、文書の形式と最新に保つ責任を誰が持つかを、契約や要件で決めておきます。プログラムを直したときに文書も直す決まりにしないと、文書と実際のシステムがずれていきます。
関連する用語
- 仕様書システムが何をどのように行うかを文書にまとめたもので、作る側と頼む側が完成の姿を共有するよりどころです。
- 基本設計(外部設計)要件定義で決めたことをもとに、画面・帳票・データ・外部とのやり取りなど、利用者から見えるシステムの姿を決める工程です。
- 詳細設計(内部設計)基本設計で決めた内容を、プログラムとして作れるところまで、処理の手順やデータの構造に落とし込む工程です。
- 要件定義システムやAIを作る前に、何のために何ができればよいのかを、使う人と作る人の間で決めて文書にすることです。
- 引き継ぎ資料システムの担当者や担当の会社が替わるときに、次の担当が仕事を続けられるよう、必要な情報をまとめた資料です。