見出し画像

社内SEの日常、説明書の誤記

とあるプログラムを改良している時のことです。
このプログラムは、連続した数値をファイルに出力する機能を持ちます。

改良前に動作を確認したのですが、明らかに異常な数字をファイルに出力しています。
現状では誰からも異常が報告されていないので、何が原因なのか探ってみることにしました。

ソースコードを含めて動作を検証してみると、プログラムの説明書が間違っていることが分かりました。
プログラムを起動するときに必要な設定に関する記述が間違っていて、説明書に書かれてある通りに動かすと、別の数値が出力されるのでした。

プログラムを使っている現場では、設定を変えることが無いので、誰も気が付かない問題なのです。
プログラムと一緒に説明書の誤記を修正することにしました。

誤記、Oを0と書き間違える人間らしい間違いです。
こういう単純だけど見つけにくい問題、数年に1回ぐらいは遭遇します。

遭遇頻度が低いので、原因を特定しにくい問題かもしれません。
私がこのプログラムをゼロから設計する立場なら、設定はアルファベット1文字ではなく、機能を意味する単語にします。

#社内SE #日常 #説明書 #誤記 #プログラム #改良 #連続した数値 #ファイルに出力する機能 #動作を確認 #異常な数字をファイルに出力 #異常が報告されていない #原因 #探ってみる #動作を検証 #説明書が間違っている #必要な設定 #記述 #プログラムを使っている現場 #設定を変えることが無い #誰も気が付かない問題 #人間らしい間違い #単純だけど見つけにくい問題 #ゼロから設計する立場 #機能を意味する単語

この記事が気に入ったらサポートをしてみませんか?