ここでは、ソフトウェア開発に必要な文書について整理しています。

ソフトウェア開発に必要な文書の一覧

開発フェーズ毎に作成する必要がある文書を以下に一覧で示します。

　上記の開発フェーズ毎に作成する文書以外に、開発とは独立して以下の文書を作成する必要があります。

　さらに、ソフトウェアの運用者と利用者のために、以下の文書があります。

ソフトウェア開発に必要な文書に記述すべきこと

　上に示した各文書には、以下の項目を記述する必要があります。

プロジェクト計画書

【プロジェクトスコープ】プロジェクトの目的・成果物・中間成果物・定量的な達成目標・制約条件・リスク、体制、スケジュール

プロジェクト計画書

【プロジェクトスコープ】プロジェクトの目的・成果物・中間成果物・定量的な達成目標・制約条件・リスク、体制、スケジュール

要求仕様定義書

要求一覧、業務フロー図、DFD

基本設計仕様書

ネットワーク構成図、ハードウェア構成図、ソフトウェア構成図

機能設計仕様書【データベース機能設計書】

テーブル定義・ER図・CRUDマトリックス図・DB容量見積もり・データフロー図

機能設計仕様書【画面系機能設計仕様書】

機能説明・画面フロー図・画面レイアウト・画面処理・入力チェック・テーブル検索編集方法・メッセージ一覧

機能設計仕様書【バッチ系機能設計仕様書】

機能説明・起動時パラメータ・テーブル検索編集方法・メッセージ一覧

機能検査仕様書

機能検査項目、前提条件、検査用データ

詳細設計仕様書

パッケージ一覧・関数IF定義

ソースコード

単体検査用ソースコード

システム検査仕様書

システム検査項目、前提条件、検査用データ

レビュー記録票

指摘事項、対応状況

機能検査報告書

機能検査結果

システム検査報告書

システム検査結果

障害報告書

障害内容

開発標準定義書【文書管理標準】

文書の採番ルール

開発標準定義書【開発環境標準】

使用する開発ツール・コーディング規約

懸案事項一覧表

懸案事項

進捗報告書

進捗状況、作業予定

議事録

議事内容、課題事項

システム構築マニュアル

インストール方法、セットアップ方法

システム運用マニュアル【定常運用手順】

システム起動停止、ディスク容量監視管理、データのバックアップ、エラー警告メッセージの監視、システム利用状況の監視、システム運用に関する作業内容

システム運用マニュアル【随時運用手順】

ユーザの登録変更削除、システムの性能改善、セキュリティのチェック・防止対策

システム運用マニュアル【障害対応手順】

システムの不具合の対処、データのリストア、不具合の報告方法

利用者説明書

機能説明、チュートリアル、リファレンス

不具合報告書

不具合内容