見出し画像

ソフトウェア開発201の鉄則 原理35:一般:同じ概念には同じ言葉を使え

要旨

* 同じ概念、同じ意味を表す言葉は、常に同じものを使うべきである
* 文章構造もしかり。同じ表現には同じ構造を用いるべき
* 例えば、「2つのタイプ」と書いたあとに、「4つの形」と書くのではなく、4つの「タイプ」と書くべきである
* 要求仕様書、設計文書、コメントといったすべての文書にこれを適用すべきである

解説

ダメな例、ここにあります(苦笑

このシリーズ、ソフトウェア開発者といったり、技術者といったり、エンジニアといったりしている。

違うものを指すののであれば仕方ないが、そうでないのなら、どれかに統一すべきである。

小説ならともかく、技術文書は、たしかに、そうあるべきだ。語句が違うと、「え?意味違うの」と思うかもしれない。それに、なにより混乱する。

そんなコストを読み手にかけさせては、ならない。これが、ユーザマニュアルやチュートリアルだと、顧客が離れていくかもしれない。それくらいの大事な話である。

とはいえ、これ、かなり難しい。なんで語句がバラバラになるんやろか。

執筆の途中で、使っている語句、あるいはこれから使う語句を洗い出して整理する、ということを、こまめに、やらないとならないのだろう。きっと。

このシリーズ、そのうちに読み直します。

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