４月から新しいプロジェクトが始まり仕事がドキュメント作成(要件確認書、基本設計、詳細設計)などをしております。この仕事自体が自分にとってあまりなじみのないものだったので、そこで思ったことなどを。
Contents
要件確認書
対象者：顧客
目的：システムの全体図やできること、機能一覧、大まかな画面遷移など。
- 現在、どんな悩みを持っていて、それをシステムでどう解決したいか
- ユースケースの具体的なヒアリング
- システムの図解、ざっくりとした処理フロー
- 顧客との認識齟齬を防ぐのが目的
- システムに関わる作業関連者のピックアップ
- データ連携などをどう行うか(テキストデータ?DBアクセス？API？)
基本設計書
対象者：顧客&詳細設計担当者
要件定義〜詳細設計をつなぐ大まかな処理フローの記載
- 要件が決まっている段階での具体的な処理フローを記載する
- 具体的にいうとシーケンス図(DBと書くビジネスロジックの結びつきなど)など。画面があればざっくりとした画面遷移
- 大まかな処理フロー(DBアクセスと他システムへの連携)
- 新規技術の実現可能性についての調査
詳細設計書
対象者：開発者
プロジェクトごとに粒度の違いはあれど、プログラムを組む人が処理の判断材料にするもの(内部の方が見て判断材料にするもの)
- 具体的な画面遷移やモックなど
- 詳細な処理フロー(システムごとのDBアクセス)
- リレーションの取得方法とデータ連携について
- エラーハンドリング
- APIであれば、InパラメータとOutパラメータ
文書作成において
- wordであれば箇条書き、アウトライン機能、をフル活用する
- ドキュメントを作る前に決定すること
- 箇条書きのフォント、サイズ、ページ改行などに注意(HTMLなどを決めるときのように大きさをすでに決めてしまう)
- 載せる部分の画像幅などの統一に注意(目分量ではなく、プロパティで設定すること)
