Java学習74時間目_eclipse影響調査の報告資料のうまい書き方について
以前、eclipseで影響調査の方法について書きました。
ここでは、
＜自分が調べた内容をどうすれば分かりやすく報告できるか＞
について書きたいと思います。
いくらがんばって調べたとしても、
上司に「よく分からん！どういうこと？」って言われたら悲しいです。
わたしの場合、まずは、＜調査報告＞を大きく二つに分けて考えます。
- 調査の観点/手順について
- 調査結果
１．調査の観点/手順について
調査の観点として、「何を調べるか」について書きます。
たとえば、「XXXXというキーワードを検索します」とか。
つぎに調査の手順として、「それをどうやって調べるか」について書きます。
たとえば、「XXXのプロジェクトを検索対象とします」とか。
ちなみに影響調査に自信がない場合は、
この時点で有識者にこの調査方法でよいか確認するようにしましょう。
２．調査結果
1をもとに調査した結果を表にして書きます。
もしエクセルを使うなら、1と2を別々のシートで分けるほうがよいかもしれません。
ここで初めて影響調査をするわたしに分からないことがあります。
調査結果を表にする場合、何を項目とすべきなの？
つまり、どういう情報があれば、見る人が満足するの？ってことですよね。
ここでは、私の思うよい項目例をサンプルとして挙げたいと思います。
[影響調査結果の表にあればいいなと思う項目]
対象 (←検索対象、どのプロジェクトを対象に検索したか)
検索ワード (←検索キーワード)
No (←項番)
クラス (←該当クラス名。長くなるけどフルパスの方がいいです。)
調査要否
参照元テーブル （任意：もし検索ワードがテーブルのゲッターであれば記載）
参照元カラム （任意：テーブルのどのカラムのゲッターか記載）
使用目的 (←そのメソッドが何に使われているか)
画面名/画面ID （←そのメソッドの影響のある画面が分かれば）
対応要否 (←影響調査の結果、影響があるかないか)
対応要否理由 (←なぜそのように判断したかについて理由を書く)
対応内容 (←影響があった場合に、どのような対応が必要になるかについて書く)
備考 /検討事項など
以上です。
みなさんが一生懸命調べた内容が、しっかり上司に伝わることを願います。
