ソフトウェア開発201の鉄則 原理51:要求:簡明に書け

要旨

＊要求仕様書は、わかりやすい文章で書こう

解説

やばい。頭いたい（笑

この原理の例。

「目標追跡機能は、すべての動いている目標の当該地点での追跡座標を画面上に表示する能力を備えなければならない」

わかりやすくした例。

「追跡に関して、システムはすべてのアクティブな目標の現在の位置を画面上に表示しなければならない」

確かに。前者は、何言ってるんだか、わからない。

簡潔な文章で書くには、訓練が必要。いくつも、伝わりやすい文章の書き方を指南してくれるサイトがあるので、参考にしよう。

出来てない自分が言うのもなんだが、伝わりやすい文章の共通項は、次のようなものと考えている。

「単語が平易である」
「ひとつの文章、言葉が短い」
「言い切る」

この3点と考えると、実践しやすい。単語の平易さ。あ、いや、「単語の平易」がダメか、「やさしい言葉を使う」かな。

同じ意味なら、普段だれでも使う言葉を選択したほうがいい。上の例だと、「当該目標」なんて普段の会話では、まず使わないだろう。特許の文章じゃあるまいし。

次。一つの文章を短く。

これも、気を付けないと、長くなる。

～だが、～なので、～だ。

みたいな。

～だ。しかし、～だ。なので、～だ。

と三つに切ったほうが、伝わりやすい。場合によるけど。

単語にしても、そう。上の例だと、

「追跡座標を画面上に表示する能力を備える」

これは、「現在の位置を画面上に表示」。

能力を備える、は全く不要。このような言葉なそぎ落としたほうがいい。

そして最後に、言い切る。

～だと思う。～だろう。～と言えよう。

なんか自信なさげで、実際どうやねん、と思うぶん、主張がぼやける。

間違っていてもいいので、はっきりと言い切ったほうが、いい。

それでは、その簡潔に書くためには、何をしたらいいだろうか。

それはカンタン。文章は、書くことで上達する。書くことでしか、上達しない。なので、書こう。

Noteに書く、というのも、有効。自分はもちろん、ここに書くのは文章力上達も狙っている。あと、Twitter はおススメ。140文字という限られたスペースで端的に言い表すことを繰り返していたら、自然と上達すること、間違いない。