1. 日本式従来のドキュメント構成
エンタープライズ開発のウォーターフォールの場合は下記のような大量のドキュメントが必要です。金融系などしっかりした会社に行くと大量のドキュメント作成の壁にぶち当たりますが、エンジニアとしての下地を作る上では結構な訓練にはなるので一通りきちんとした文書が書けるようになるのが望ましいです。文章化できない曖昧な事象をそもそもコード化できないので練習としては素晴らしい訓練になるでしょう。
| 入り口ドキュメント | 出口ドキュメント | 備考 |
|---|---|---|
| 要件定義書 | システムテスト項目書 | 要件定義書は必要 |
| 基本設計書 | 結合テスト設計書 | 基本設計書相当は必要 |
| インターフェイス仕様書 | API仕様書/クラス仕様書など | ドキュメントはswaggerやjavadocなどで置き換え |
| 詳細設計 | 単体テスト | RubyであればテストはRspecで置き換え |
| 画面設計 | - | XDなどのワイヤーフレームツールで置き換え |
| WBSスケジュール | プロジェクト進捗報告 | JIRAなどのグループウェアで置き換え |
| テスト仕様書 | QA報告書 | JIRAなどのツールで置き換え/報告書も置き換え可能な場合あり |
2. 普段利用しているテンプレート
ワイヤーフレームであったり、チケット管理ツールやQAツール、テストコードをかけるフレームワークがあったりとここ最近は開発事情が変わってきているので、無駄を省くために最小限のドキュメント構成でプロジェクトを進めたいです。
日系,外資(というより外国企業)でそこそこエンタープライズな規模でプロジェクトをやってみて
、最低限必要と思われる文章だけテンプレート化しておきます。
設計書やテスト項目書が最低限なのは上述の通りツールを用いて代替する前提だからです。
| 英設計 | 日設計 | 英テスト | 日テスト |
|---|---|---|---|
| System Requirement | 要件定義書 | Test Plan | システムテスト項目書 |
| 上記ドキュメントに包括 | 基本設計 | 上記ドキュメントに包括 | 接続テスト項目書 |
*リンクがあるものはダウンロード可能
*パワポ、ワード、エクセルなのでダウンロード読むなりしてください
*いくつかいいテンプレがなかったものについては見つけ次第更新