ソフトウェア開発の場合には、プログラムをなるべく短く書く事が推奨されます。なぜなら
- 短いコードの方が通常読みやすい
- 長いコードよりメンテナンスしやすい
- 長いコードほど、バグが混ざりやすい
これらはテクニカルライティングにも同じことが言えます。
- 短い文章ほど、速く読める
- 長い文書よりメンテナンスしやすい
- 長い文章ほど、文章の間違いが起こりやすい
短い文章で表現することには意味があり、コミュニケーションの質が上がり、容易に理解できるようになります。
それぞれの文は1つのアイディアに絞る
１つの文章には１つのアイディア、概念、思考を記述するのみにします。
１つの長い文章にあれこれ詰め込むのは良くありません。
| 1950年代後半は、IBMが1957年にFortranを発表し、翌年ジョン・マッカーシーがLISPを公開したことで、プログラマーは繰り返しや再起が使えるようになり、プログラミング言語にとって重要な時期である。 |
この長い文を幾つかの短い文に分割すると次のようになる。
| 1950年台後半はプログラム言語にとって重要な時期であった。IBMは1957年にFortranを発表。翌年、ジョン・マッカーシーがLISPを発明した。その結果1950年代後半には、プログラマーは問題を反復的・再起的に解けるようになった。 |
長い文はリストに変換する
非常に長い技術文章は分割してリスト化すると読みやすくなります。
| 通常のループ処理から抜ける場合、break文（現在の繰り返し処理の外に抜ける）かcontinue文（繰り返し処理の残りの部分をスキップして、次の繰り返し処理に移る）を使う事が出来ます。 |
上記の文例の場合は2択になっています。これは箇条書きリストにすることが出来ます。
もし作業指示のような順番が決まっているものについては番号付きリストにします。
| 通常のループ処理から抜ける場合は、次のいずれかの文を呼び出します。 break： 現在の繰り返し処理の外に抜ける continue：現在の繰り返し処理の残り部分をスキップして、次の繰り返しに移る |
無用な言葉を削る
多くの文章には「フィラー(filler)」と呼ばれる、無用の言葉が散りばめられています。
| 100 以上の入力値が登録される場合、ログ記録を生じさせます。 |
簡潔な言葉を選び、無関係な言葉を削る事で、より簡潔な短い文章に書き直すことが出来ます。
| 100 以上の入力値はログに記録されます。 |