エンジニアの文章力について

エンジニアの文章力について

改良提案や仕様書の説明のとき、文章について困ったことありませんか?

エンジニアは、システムに詳しくない人、詳しい人、様々な人にシステムの内容を説明するために、文章を書かなければいけません。

今回は、エンジニアが文章を書く際に、大切なポイントについて、解説したいと思います。

文章力のポイント①:誰に対して書くのか

誰に対して書いているのかを意識することが大切です。

エンジニアが文章を書く際に、相手にするのがパターンが2通りあります。

  • 相手もエンジニアまたはシステムおよびプログラムについて詳しい
  • 相手は、システムについて全く分からない

相手がシステムについて詳しい場合、多少、文章がシステム的で難しく書いても問題ありません。

相手がシステムについて全く分からない場合、システム的な言葉やIT系の言葉を使ってしまうなど、文章をかみ砕いて説明しなければ、相手に伝わりません。

文章力のポイント②:ゴールを考える

文章を書く際にゴールを考えながら書くことが大切です。

  • 改良提案であれば、発注をしてもらえることがゴール
  • システムの説明であれば、理解してもらえることがゴール

ゴールを意識せずに書くと、途中で自分の書きたい事ばかり書いてしまい、軸がブレてしまいます。

文章力のポイント③:余計なことは書かない

これは、エンジニア以外にも言えることですが、事実すべてを書く人がよくいます。

例えば、時系列で書くのはいいですが、起こったことすべてを書く人がいますが、必要な部分だけでいいんです。

文章量が多ければ、相手に伝わるような気がしてしまいますが、伝えたいことが何か(ゴールは何か)を考えて、伝えたいことにたどり着くために文章を書きましょう。

どうしても文章量が多くなってしまう人は、システム等の内容の理解が足りてない場合があります。

理解が足りてないから、どれもこれも必要な説明に思えてしまう場合があります。

まとめ

  1. 誰に対して書くのか意識する
  2. ゴールを考える
  3. 余計なことは書かない

上記のポイントを意識しながら文章を書くようにしましょう。
意識することが大切です。
意識しながら書くことで、いずれは、意識しなくても書けるようになります。

以上、エンジニアの文章力についてでした。

P.S

最近読んだ本に日本人は、他国と比べて、社会人になってからの学びが足りないと記載がありました。

ぜひ、皆さんは、社会人からの学びをしましょう。