.log(ぽちろぐ)

福岡.平尾に住んでるSE(スーパーエロい)の日記。

設計書においては、"より"って語句を禁止したい。

 意味が複数あるから。「〜よりも」「〜によって」「〜から」の意味がある。

 アホが書いた設計書読んでると、"より"って語句が頻発する。例えばこうだ。
「ユーザにより入力された値がテーブルより取得した値より大きい場合」
厳格な文書において、複数の意味を持つ語句を使用すべきではない。そんなのは俳句や短歌でやればよろし。

多少の国語力があるエンジニアはこう書く。
「ユーザが入力した値がテーブルから取得した値よりも大きい場合」
これならば、誤解しようがない。設計書として適切。

 非常によく訓練されたエンジニアはこう書く。
「ユーザの入力値 > テーブルの値 の場合」
記述量が短く、意味の取り違えが発生する可能性が低い。設計書はかくあるべき。