ドキュメンテーションとは
- 構築時に作成する
- パラメータシートを見ればどこに何を設定すれば良いのかわかる
- 手順書ではない
- 構築ができるレベル
- 既定値と変更後の値が記載されている
- なので、変更しているところをメインに説明する
ポイント
悩んだら書く
後々加えるのは面倒なので、書くかどうか悩むのであれば、とりあえず書いてしまえば良い
文章は書かない
画面の設定内容を書くのであって、あなたの文章を書くことはない！
画面と同じように書く
画面の通り書くというルール
自動翻訳で日本語がおかしかったとしても、そのまま書く
変化する値は記入しない
状態や時間や回数など変化する値
例えば電源のオン/オフ
凡例にない記号は使用しない
選択するしない、既定値などの値については凡例で定義する
凡例にない記号は絶対に使用しない
逆に新たに使用したい記号や、元の記号を変更したい場合は凡例で定義する
記載の意図を説明できるようにする
自分が作成するパラメータシートなので、記載の意図は全て説明できるようにする
「雛形がこうなっていたので〜」は通用しない
ドキュメントの種類
【要件定義フェーズ】
要件定義書
【基本設計フェーズ】
基本設計書
運用設計書
【詳細設計フェーズ】
詳細設計書
パラメータシート
構築手順書
【テスト計画】
全体テスト計画書
テストケース一覧
単体テスト
結合テスト
総合テスト
仕様書
報告書
【移行フェーズ】
移行計画書
移行手順書
【運用フェーズ】
運用手順書
疑問点
ドリルダウンなどで選択した値によって既定値が変わるものはどうしたら良いのか
苦労したこと
- とにかく記述量が多すぎる
- どこまで書けば良いかわからない
- 設定変更した箇所だけで良いのか、それとも全て必要なのか？
- そもそもなぜ記述するのかをきちんと理解しないといけない
バージョン管理について
クライアントに提出するものが1.0~
内部バージョンが0.1~
発行日：レビュー日
発生元：指摘をもらった人
指摘内容：なるべく言われた通りに記述する・要するにこういうこと？ってのは聞いてから書くようにしたほうがいい
「〜という認識で大丈夫ですか？」「〜という点を修正すれば良いでしょうか？」
検討結果：
確認して修正してくださいの真意
「確認して」と「修正してください」は別のフローなので、まずは確認する
確認して、どうしたのかということを伝える
「確認して、項目が不足していたため、追記いたしました」
「確認し、検討した結果、全ての項目を記載しておりました」