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