安田です。
いつも思っていることですが、
取扱説明書や、解説用の文書で
なんだかとてもむずかしく書いてしまう人って
いますよね?
それからもう一つ。
だれもがわかるように、
システムの仕組みを文書化してほしいのに、
なぜか、ソフトウェアのロジックを解説していて、
はい、できました・・・と持ってくる。
んー、そりゃちがうだろ・・・と。
とにかく、「他の人に読んでもらう」ということが
どういうことなのか、理解できていないようです。
かくいう私も完璧なわけではありませんが
わかりやすく、読みやく、理解しやすく を
心がけています。
じゃ、どれくらい簡単ならOKなのか?
よく言われるのが、
「小学生に読ませてわかるくらいが最適」
とか。
さすがに説明書などは、
専門用語が出てくるので
小学生はちょっとムリかな。
まあ、それでもなるべく
一般的な言葉に置き換えたり
例えば、こうです・・・みたいなふうに書いたり
工夫するようにしています。
どうして難しく書きたいのか?
なんでみんな、もっとわかりやすく書こうとしないんだろうか?
その文章で、だれが理解してくれるんだ?
文章の補足でしゃべらなきゃいけないのでは
文書化できていない。ということだと思いますよ。
自分のわかっていることは、
他のだ~れもわかっちゃいない。
技術者であれば、それに気づくことも
自分自身のレベルアップに
とても重要なことだと思います。
P.S.
もしあなたが、PMCラダーの設計、改造、デバッグ、
機械の調整運転などの体力勝負で困っているのなら、
手とか頭とかの助けになる可能性が十分にあります。
↓
PMCラダー屋.COM
https://www.pmcladder.com/
この記事は役に立ちましたか?
もし参考になりましたら、下記のボタンで教えてください。