はじめに
ここ最近、案件先で調査業務をすることが多くて
調査に関して、色々考えることがあり
その考えについて、まとめていきたいと思います。
最近の業務の出来事
最近の業務で、だいぶ前に書かれたソースコードを見て
どのような処理をしているか調査する機会がありました。
その時にソースコード見て、何となく処理は分かるけど
具体的になぜそのソースコードを記載したのか意図が分かりませんでした。
しかし、調査していく内にその当時に記載された設計書とテスト仕様書（及びエビデンス資料）を
発見しまして、その資料を見てソースコードの意図を理解しました。
その出来事で思ったこと
以下、上記の出来事で思ったことをいくつか記載させてもらいます。
設計書は大事
設計書があったおかげで、ソースコードの意図を理解したので
改めて設計書の大事さを学んだような気がします。
今回の経験を通して、「自分が書いたソースコードや設計書は後々誰かが見るかもしれないので
そのことを意識して作成するようにしよう。」と思うようになりました。
テストのエビデンス資料は大事
設計書の部分と重複している所もございますが
テストのエビデンス資料を作成する際に
以下のことをすると思うのですが
- 画面のスクショをとる。
- 大事な部分は赤枠や図形で強調する。
- DBが絡んだ場合、該当のテーブルのレコードを挿入する。
上記の作業にはかなりの手間がかかりますよね。
そのため、エビデンス資料を作成するのが億劫に感じる時もあると思います。
ただ、今回の調査で本当にエビデンス資料のありがたみを感じました。
今まで自分は、エビデンス資料を作成する理由として
「自分自身がしっかりと調査したという証跡を残すため」
だと考えていました。
上記の理由も間違いではないと思うのですが
それに加えて、今回の経験を通して
「将来、他の人が調査や改修を行う際に、このエビデンスを確認することで、
新たな方針を見出すきっかけとなる。」
と思うようになりました。
ソースコードを書く際は、コメントを残そう。
当たり前なことだと思うのですが、大事なことなので改めて書きました。
実際に、調査・改修・保守など
あらゆる場面において、自分が書いたソースコードを確認されることはあると思うので
引き続き意識しようと思います。
さいごに
色々書かせてもらいましたが、今回の記事で一番伝えたかったことは以下のことです。
自分が作成したあらゆるものは、後世の人の助けになるかもしれないので
そのことを意識して作成していこう！！
皆さんお忙しいと思いますので、分かっていても中々できないこともあると思います。
ただ今回の調査業務で、以前担当された方の資料が役に立ったのは間違いないので
ほんの少しで構いませんので、今回自分が書いたことを意識していただければ幸いです。
（少なくとも自分は、意識するようにします！）