Webエンジニアが最低限作るべきドキュメント【現役エンジニアが解説】

PROGRAM

今回は、Webエンジニアが最低限作るべきドキュメントについて、実体験をもとに簡単に解説していきます。

インターフェース仕様書

他システム等との連携がある場合、インターフェース仕様書は必ず作ります。

これがないと、どのようなファイルやデータを連携すれば良いかわかりません。

インターフェース仕様書には連携すべきファイルやデータのフォーマットを記載します。

通常、リクエストデータとレスポンスデータに分けて、それぞれのレイアウトを記載します。

これらの情報は連携をする上で必要不可欠なものなので、ドキュメントの中ではインターフェース仕様書は最も重要なものと言えます。

テーブル定義書

テーブル定義書も納品物にほぼ必要とされます。

テーブル定義書は、データベースのテーブルの項目一覧のことです。

項目名とデータ型、その項目の説明が最低限、書かれている必要があります。

これはデータベースを扱う上で必要となるため、求められるケースがほとんどです。

また、どのようなデータが入っているかを把握するという目的からも、求められる可能性が高いです。

テスト仕様書

テスト仕様書も求められることがあります。

テスト仕様書はテストの工程で作られるドキュメントになります。

テスト仕様書には様々なテストケースとそのテスト結果を記載します。

インターフェース仕様書やテーブル定義書ほど、ユーザ側からは求められません。

しかし、大手企業等の品質を管理する部署がある場合には、テストの証拠として求められることがあります。