分かりにくい文章にある多くの共通点
suyamada以前の投稿でエンジニアの成長に最も必要なスキルは論理的思考力と記載したことがあります。
その中で論理的思考力を養うためには文章を書くことが重要であるともお伝えしました。
論理的思考力とは、物事を整理し、因果関係や優先順位を明確にする力です。
このスキルは設計、構築、トラブルシューティングなどエンジニアの多くの業務で求められます。
文章を書くことは思考を整理することに直結するため、論理的思考力を養うためには文章を書くことが重要となるのです。
エンジニアの仕事は1人で進められるものではなく、多くの場合複数メンバーで協力、連携し合って進めることになります。
発生している状況や自分の考えを正しく伝えるためにも分かりやすい文章を書く必要があるのです。
分かりやすい文章の例を挙げるよりも分かりにくい文章の例を挙げる方が理解しやすいため、ここでは分かりにくい文章にある多くの共通点についてお話します。
- 省略が多い
書き手が既に知っていることについて省略されてしまうことが少なくありません。
前提条件や説明が省かれていると、読み手がどういう背景で何が起きているのか理解できません。
読み手の立場に立って何の情報をどんな順序でインプットすると理解しやすいのかを考えましょう。
悪い例：ネットワークが繋がらないという問合せが複数きています。お客様側で確認いただけますか。
良い例：社外からVPN接続できないという問合せが複数きています。
VPN機器が正常に起動しているかの目視確認と社内からVPN管理画面に接続できるかご確認いただけますか。
- 曖昧な表現
曖昧な表現をされると読み手が混乱する場合があります。
例文に挙げた「基本的に」「もうすぐ」以外にも「場合によっては」「一部は」「おおよそ」「大体」「いずれ」なども曖昧な表現です。
曖昧な表現をせざるを得ない場合もありますが、可能な限り曖昧な表現は避けるべきです。
悪い例：5つのエラーが発生しましたが基本的に問題ありませんでしたのでもうすぐ解決します。
良い例：5つのエラーが発生し、そのうち4つはメーカー回答で問題ないことが確認できました。
もう1つのエラーについても引き続きメーカー調査中ですが本日18:00までに回答いただける予定です。
- 専門用語の多用
読み手の理解度を考えずに専門用語や略語をそのまま使用しているケースがあります。
悪い例：現在、メールシステムにおいてNDRが大量に発生し、NDRによるキュー滞留が発生しています。
良い例：現在、メールシステムにおいて配信不能レポート（=Non-Delivery Report。以下、NDR）が大量に発生しています。
その結果、NDRを含むメール配信に遅延が発生しています。
- 論理の飛躍
説明が不足して論理の飛躍があると、読み手が結論に至る過程を理解できない場合があります。
悪い例：システムが遅くなったので新しいハードウェアを導入するべきです。
良い例：システムが遅いので原因を調査したところ、ピーク時にメモリ使用率が100%に張り付いていることが判明しました。
ソフトウェアメーカーに確認したところ、同規模の他社システムに比較してもメモリが不足しているとの指摘があったため、
メモリ増設を検討するべきです。
ここまでで分かりにくい文章にある多くの共通点についてお話しました。
私自身、文章が苦手で新人時代に添削にあたってくださった先輩は「お前の文章を読むのは本当に苦行だよ」とため息交じりに言われたものです。
他人の文章を添削することで何が良くないのかを第三者視点で理解できるようになります。
自分の文章は自分で書いたものであるため、評価がどうしても甘くなってしまいます。
また、文章が苦手な人は文章が上手だと思う文を自分で繰り返し書いてみるという方法もおすすめします。
エンジニアに限らずどんな職種においても分かりやすい文章がかけるということは重要なスキルです。
一度習得してしまえば一生モノのスキルといっても過言ではありません。
苦手だと思っている方はこの機会に文章に取り組んでいただけたらと思います。
Follow me!
