伝わる!...かもしれない。エンジニアの文章力向上を読んだ

はじめに

一昨日辺りに、エンジニアのための日本語文章テクニックを読んだので、引き続き日本語文章系の本を読んだ感じです。

文章での注意点

• 誤字・脱字をしない
• 表記を統一する
  • カタカナ語の伸ばし棒有無
  • カタカナ or 英語
• 何も考えずに漢字を使うのはやめる
• 適切に接続語を使う
• 翻訳調の書き方をしない
  • 言い換えられないかを検討する
• 抽象的な書き方をやめる
  • できるだけ具体的に書く
    • 抽象的に書いたほうがわかりやすくなる場合もあるので、相手に合わせるのがベスト
    • 数字を入れる
• 主語と述語を近づける
• 文章は長くしすぎない
• 二重否定は使わない
  • 物事を伝えるだけなら、二重否定は不要

文章構成での注意点

• 相手が欲しい物を先に書く
  • 5W1H をなるべく最初に持ってくると良いと思った
• お話の背景を添える
  • 質問されそうな前提条件は先に記述しておく

読んでみて

前回読んだ文章力向上の本は、すべての文章に適応できる内容でしたが、 今回の本は、エンジニアとして働く上で覚えておくと良い内容が多かったと感じました。

個人的には、以下 2 点が重要かなと思いました。

• 相手が欲しいものを先に書く
• お話の背景を添える

これらをピックアップした理由は以下です。

相手がほしいものを先に書く

タスクなどは、Backlog、torello、Jira などで、 チケット として管理することが多いと思います。チケットは基本的にタスクをお願いするために書くケースが多いので、欲しいもの（タスク状況やタスク内容）が先に書かれていると、実装者が対応内容を理解しやすくなり、作業効率がアップすると思われます。

お話の背景を添える

タスクを対応する上で、タスクの背景を知っていると、成果物の品質が上がると考えています。タスクの背景を知っている場合は、自分が知りうるすべての解決策の中から回答を選べるため、今の解決法とは別の案を提案できる可能性があります。一方で、背景を知らない場合、実装者はどうのような話の流れで現在の結果に行き着いたかがわからないため、とりあえず言われた通りに実装しがちだからです。 前提条件を伝えることで、メンバー同士で考える時間が増え、より良い Output が期待できると思います。

最後に

連続で文章能力向上の本を読みましたが、ちょっと気にするだけで変えられる点が多いと思いました。文章を書くときは上記内容を思い出して、日本語 noob を抜け出せるようにしていきたいです。

参考

• (物理本)伝わる!…かもしれない。エンジニアの文章力向上 - denki-macaron - BOOTH