ドキュメント作成メモ

---

ドキュメント作成時の基本(注意点)

• 用語は、同一意味の用語が氾濫しないよう統一して定義/使用すること

---

フェイズごとの作成ドキュメント

フェイズ	ドキュメント
要件定義	要件定義書
基本設計	基本設計書(外部設計書)
	基本設計書 兼 操作手順書
	データ定義書
詳細設計	詳細設計書(フロー、シーケンス)
	エラーコード定義
テスト	テスト仕様書
	バグ票
その他	用語集
	QA、問題点、TODO票
	運用手順書
	オペレーションマニュアル(操作手順)

---

ドキュメント概要

• 要件定義書
  • プロジェクトの要件を説明した資料
  • 通常、顧客から提供される
• 基本設計資料
  • 基本設計書(外部仕様書)
  • または、基本設計書兼操作説明書
    • システム外部仕様を記述した仕様書
    • どう操作したらどうなる、とか、input→処理→outputを簡潔に記述する
    • GUIの画面遷移
    • 各画面の詳細説明(ここで操作仕様も説明しても良い)
    • 状態の定義とアクションによる状態遷移等も定義する
    • 仕組み(内部処理)の詳細は内部仕様書に記述する
  • データ定義書
    • 出現するデータの特徴や、ファイル名、フォーマット等を定義した仕様書
• 詳細設計書(内部仕様書)
  • ソースレベルの設計を記述した仕様書
  • クラス、関数の一覧やクラス図、処理シーケンス等
  • API仕様書
• テスト仕様書
  • テスト仕様書
  • バグ票
• オペレーションマニュアル
• 運用手順書
• その他
  • 進捗管理資料
    • MSProjectなどで作成
  • QA表
    • 以下を１つのExcel等にシート分けして顧客と適宜(または進捗報告時)にやりとりする
    • 質問事項一覧
    • 問題点一覧
    • TODO一覧
  • 用語集
    • プロジェクトの専門用語やプロジェクトで使用する技術用語などの用語集
    • メンバの入れ替わりがなければ無くてもなんとかなるが、あったほうが良い
  • プロジェクト説明資料
    • 新規メンバへの導入資料として用意しておいたほうが良い

---

外部仕様書 兼 操作説明書テンプレート詳細

• 表紙
  • ～ 基本設計書 ver x.x
• 変更履歴

こんな幹事

• 目次
• 1. はじめに
  • 1.1. 目的
    • 本仕様書は...である。
  • 1.2. 参考資料
    • ～書 ver x.x
    • ～書 ver x.x

1. 1. システム概要

---

英語表記

• Contractor Project Initiation Complete & Approved（要件定義）
• Requirements Completed & Approved （基本設計）
• Design Completed & Approved（詳細設計）
• Coding/Unit Test Completed & Approved（開発・単体テスト）
• Integration/Testing Completed & Approved（結合テスト）
• System and Acceptance Test Completed/Approved（システム（プロダクト）テスト）
• Field Testing Completed & Approved （運用テスト）

---