SEが作業する際に意識すべきこと

よく自分の部署に改修案件などが回ってくるものは、あるべきドキュメントがなかったりして、コードを全部読んで、意味を理解しなくてはいけない、ということが多々あります。この業界では、ドキュメントがしっかりそろっていることなんてそうそうない、なんて言われたこともありますが、それでも、仕事をよそに回すなら、本来のあるべき姿で回すのが社会人でしょう。

中にはコードを読むのが早い人がいて、ぱぱっと改修作業終わらせる人もいますが。。。私は読むのが遅いです。
作ったツールがより良いものになるためにも、以下のリストを自分では行なっています。

用意されているもの。

①項目説明書、手順書、プログラム
この三つはマストだと思います。
できれば、ドキュメントは、README.md で作成しておくのが良い。けど、現場ルールでエクセルで作成しておくことのほうが
多い気がします。

②Gitなど、更新履歴の管理
レガシーな現場だとなかなか使っているところもないのですが、もしあるなら、これの有無は確認すべき。

③コードの意味、目的など

プログラムにコメントアウトして書くことも多いですが、それとは別にドキュメントにまとめておくと、わかりやすいです。

SEはどちらかというと炎上されているプロジェクトに投入されがちです。これらドキュメントがない状態で、回されることも多く、結構大変な思いをしました。
作業する際はこれらを意識して、いつでも手離れして大丈夫なようにしてます。

「美しいコードを書く」ということの前に、揃えるべきものは揃えておきましょう。