by shigemk2

当面は技術的なことしか書かない

エンジニアの文章が分かりにくい原因について

一通り読んでも「なぜエンジニアは文章が下手」なのか分からなかった、というか、
「別にこれエンジニアだけの話じゃなくね?」という感想だった。

なのでとりあえずエンジニアの文章が分かりにくい3つの原因について書いてみる。

知識のギャップ

読者が知らない専門用語を無造作に使ってしまう。

「送信」機能はデフォルトではエンターキーに割り当てられてます

エンジニア以外の人間は、「デフォルト」がなんなのか知らないのに、
無造作に専門用語を使われるとしんどい。

しかし専門用語を言い換えるのはいいが
説明するのにコストがかかるから、そこらへんの兼ね合いが重要である。

目的のギャップ

NxTester(仮名)は一般的な事務所で多くのPCからのアクセスが集中するファイルサーバにおいて、クライアントPCの増加に伴い、
ネットワークとサーバの性能がどの程度変わるかを推計することができるツールです。
NxTexterは実環境におけるクライアントPCからのファイル要求へのサーバの応答性能を実測し、その実測値をもとにして
シュミレーションを行うことができ、将来のクライアントPC増加時の性能変化を高精度で予測することが可能です。

この文章だけ読んでも、「性能の変化を計測して、どうしたいの?」という疑問が技術を知らない読者から出てくるでしょう。

このように改善してはどうでしょう。

一般的な事務所で多くのPCからのアクセスが集中するファイルサーバの性能は、業務効率に直結します。NxTesterは
ファイルサーバの性能を維持向上させる増強計画を精度よく立案するための最強の武器となるツールです。

相手の目的は何かをはっきりさせる文章が肝要です。

責任転嫁の誘惑

「俺がこの説明文を理解できないのは、書き方が悪いからだ、ほんとITエンジニアは文章力ねーよなあ」と言いたくなる
誘惑のことである。

ただ、文章が分かりにくいのは、ITエンジニアだけの責任ではないし、
ある程度読み手に協力して貰う必要はある。