自分だけで使う前提が崩れた
これまでは、
自分が使うスクリプトとして書いていました。
多少読みにくくても、
仕様を忘れていても、
「自分なら分かる」で済んでいました。
ですが、
他の人に渡すことになった瞬間、
前提が崩れました。
最初に気づいた違和感
見返してみると、
いくつもの問題がありました。
- 変数名が省略だらけ
- コメントがほとんどない
- 使い方がコードを読まないと分からない
動くことと、
渡せることは別だと実感しました。
直したポイント① 名前
まず手を入れたのは名前です。
# 修正前
def proc(d):
...
# 修正後
def process_sales_data(data):
...
名前を具体的にしただけで、
コードの意図が伝わりやすくなりました。
直したポイント② 入口と出口
次に整理したのは、
スクリプトの使い方です。
- 何を入力するのか
- 何が出力されるのか
- どこを触っていいのか
if __name__ == "__main__":
main()
入口を一つにしたことで、
迷いにくくなりました。
直したポイント③ 失敗時の振る舞い
自分用では、
エラーが出たら直せばいいだけでした。
他人に渡す場合は、
そうはいきません。
- エラー内容を分かる形で出す
- 次に何をすればいいか示す
print("CSVファイルが見つかりません。パスを確認してください。")
これだけでも、
問い合わせが減りました。
作って分かったこと
この経験で分かったのは、
- 他人に渡す＝設計が露出する
- 読まれない前提は危険
- 思いやりはコードにも出る
ということです。
おわりに
この話は、
スクリプトを他人に渡す前に
直したポイントを振り返った実践ログです。
「自分用」と「共有用」は、
別物だと強く感じました。
コメント