悪あがきプログラマー

悪あがきを続けていきたい技術と書評なブログです。トレタでiOSエンジニアやってます。

SEの文章術

最近、業務習得資料というものを作成している。
要するに引き継ぎ資料だ。
特に今、要件定義時に作成する資料について、
盛り込む内容と、書き方をまとめているのだが・・・

実はここで苦労している。
文章が書けない。


致命的だ。


そこで、昔購入していた「SEの文章術」を引っ張りだしてきた。

SEの文章術 (技評SE新書)

SEの文章術 (技評SE新書)

下手な文章とは何か

  1. 書き手の言いたいことが明確でなく、主張が伝わってこない
  2. 内容の構成や順序が整理されておらず、わかりにくい
  3. 主張を裏付ける情報がなく、論理的に納得出来ない
  4. 難しい用語が定義しないまま使われ、意味が分からない
  5. 長い文が続くうえ、冗長な言い回しが多く、読みにくい

よって、
「伝わってこない」「わかりにくい」「納得できない」「読みにくい」
となる。


私の場合は1,2,3が該当しているようだ。
では、どうすれば読みやすくなるのか?

課題 解決策
「伝わってこない」「わかりにくい」 何のために何を述べるのか(WHAT)
「納得できない」 根拠をいかに示せるか(WHY)
「読みにくい」 いかに読みやすく表現できるか(HOW)

こう並べて見ると、非常に当たり前のことに見える。
まぁ、それがうまく出来ない訳だが。

その他の気をつけるべき点

心理的な作用

  • 曖昧な表現は避ける
  • 受動態よりも能動態
  • 否定形よりも肯定系

なぜ必要なのかを明記する

  • その機能はなぜ必要か。そもそもの目的は何か
  • その機能は、だれがどのタイミングで必要としているのか
  • その機能を実現できないとすると、どんな不都合が生じるのか

文章力を向上させるには

残念だが、近道はないらしい。


上達法としては、「三多の法」があるという。

  • たくさん本を読む
  • たくさん文章を書く
  • たくさん推敲して書き直す

「量より質」というのは質を評価出来るレベルの人の話。
したがって、最初のうちはとにかく文章の量をこなすことが大切だそうだ。