More than 1 year has passed since last update.

設計から実装を開始するまでの間に作成するドキュメント一覧

Last updated at 2023-12-07Posted at 2023-02-16

はじめに

今回紹介するドキュメントの一覧は、あくまで自分の就業先で作成したものになります。
就業先によっては、多少内容が違うことも多いので、そこはご了承ください。

設計から実装に入るまでに作成するドキュメントはこちらになります。

・全体工程表
・議事録
・QA票
・文書管理台帳
・プロジェクト計画書

1つずつ説明していきます。

プロジェクト計画書
この計画書は、プロジェクトの目的やスケジュール、開発計画などを書いていくものになります。一番はじめに作成するものがこの計画書で、プロジェクトの元になるものなので、大切なドキュメントになります。

全体工程表
この表は、設計からリリースまでの工程を記入するものになります。工程を進める上で、変更が加わる事もよくあります。

議事録
ミーティングの内容などをまとめておくメモ的なものです。相互の認識の違いなどが無いようにするために必要なものであったりするので、結構重要なものになります。

QA票
要求定義書を見て、仕様に対しての疑問点を洗い出して、顧客に質問する要件をまとめる表になります。
これが結構大切で、ここでしっかり顧客とやり取りをして、記録として残しておかないと、仕様で揉めたりした時に、言った言ってないになってしまいます。

文書管理台帳
これは各設計書などを作成した日時などをまとめるものになります。

※基本設計書の具体的な内容はこちらの記事にまとめてあるので、今回は割愛します。
https://qiita.com/hukuryo/items/97797a91d7e2ee0bcabc

技術調査報告書
技術調査を行った場合に作成して、顧客先に見せる報告書になります。技術調査は、実際にこれからやろうとしているプロジェクトに際して、技術的に実現できそうかどうかを判断するための調査であり、非常に重要な工程になります。

レビュー票
顧客先と基本設計についての読み合わせを行なった内容をまとめるために作成するドキュメントになります。ここに、読み合わせの内容をしっかり記録しておくことで、何かあった時の証拠にもなりますし、設計や実装を進めていくうえで役に立ちます。

検討課題表
基本設計の読み合わせで出た検討すべき課題をまとめるためのドキュメントです。

詳細設計書は、基本設計の内容を掘り下げて、実装するときに使用するデータなどを記述していきます。
詳細設計の中で作成する、クラス図とシーケンス図についてはこちらの記事をぜひご覧ください。

単体テストの仕様書を書きます。
ユニットテストの説明に関しては、こちらのサイトがわかりやすかったです。
https://www.techmatrix.co.jp/t/quality/unittest.html

結合テストの仕様書を書きます。
結合テストの説明に関しては、こちらのサイトをご覧いただくとわかりやすいです。
https://products.sint.co.jp/obpm/blog/join-test

繰り返しにはなりますが、現場によって作成するドキュメントは変わってくるので、あくまでも参考程度にしていただければ幸いです。
以上になります。