【エッセイ】ちょっとしたツールを作る際に気を付けること

ちょっとしたツール

開発をしていると、テストなどを行う際に、「ちょっとしたツール」を作成することはよくあると思います。テストのほかにも、ちょっとしたビルドツールやデプロイスクリプトなどプロダクトコード以外のコードも「ちょっとしたツール」に含まれます。今回はこの「ちょっとしたツール」について話していきたいと思います。

自分のためのツールが...

上記のツールなのですが、まず、最初は自分しか使わないのですが、ほかの人が使いたいといった場面が必ず訪れます。（私の経験上、必ず訪れます...）
しかし、このようなツールは自分しか使うことを想定していないので、コードや設計が適当に作られることが多いです。他人に引き渡す際に適当なコードで恥ずかしいこと思いをすることが多々あります。
自分が恥ずかしい思いをするだけなら、まだいいほうですが、そのようなツールは「オレオレな使い方」になっていることがほとんどです。ツールを適当に引き渡して、その引き渡した人が本番環境でそのツールを使ってしまい、DBにテスト用データをぶち込んでしまうこともあるかもしれません。

プログラマとしての心構え

プログラマとしてコードを書くなら、いつ・どんなコードもどんな使い方をされるかわからない、または、いつ人に見られてもいいようにコードを書くべきです。また、どんな使い方をされてもいいように設計しないといけません。