コンテンツにスキップ

【わかりやすいマニュアルの作り方】第184回 テクニカルライティング教育

少しだけ涼しい風が吹くようになってきました。ただ、降るときは凄い勢いで雨が降るので、温かい空気が残っているのだなと感じます。

さすがに35度を越える高温ではエアコンをつけないと生活が不可能なので(仕事をしようにもまったく頭が働きません)その分だけは助かったと言わざるを得ません。

■テクニカルライティングはだれが教える?

さて、今回はテクニカルライティングのやり方をどうやって身につけるか、という話をします。

自分自身は、とても幸運なことに、プログラマーからマニュアルのセクションに異動し、現場でプロの編集者の下にあって丁稚奉公方式で覚えました。
しかし、この方法は、たくさんの人数を教えることができるわけではないので、効率の面ではとても褒められたものではないやり方です。

実は、さきほど国文科出身の人にちょっと尋ねてみました。

「国文科では『わかりやすい説明』とか『技術文書の書き方』とかの教育って、どこかでやっている?」

「うーん、ないと思う」

「え?、ないの?」

「うん、でも他にどこで教えるかというと…えーと」

結局、技術文書の書き方については、大学のレポートや論文の指導か、ビジネススクールのレポートの書き方・プレゼンテーションのやり方といったところでしか指導をしていないんじゃないか、という結論に落ち着いた。

逆に言えば、技術文書を書くエンジニアのほとんどは書き方を習う機会がまったくないということである。

■書き方を身につける

とはいえ、業務では説明文書や技術文書は内容を理解しているエンジニアが書かなければなりません。よほど人数に余裕があって、専門職を当てられるというところでもあれば別ですが、あいにくそんなところはいまのところ見たことがありません。

では、どうしたらよいでしょうか。

普通の場合、以下のような解決方法を選択することになります。

  1. 今までやってきた技術文書の書き方を踏襲する
  2. テンプレートを制定して、それに従う
  3. プレゼン用の資料の作り方で説明資料も作成する

…etc

もちろん、プレゼンテーション用のPowerPointで制作するにしろ、あらかじめ定めたテンプレートを使用して制作するにしろ、元のベースとなるものがしっかりとしていれば、少なくとも元のエンジニアが制作したものよりは(見せるためのものという意思が入っているだけ)良い物になっているでしょう。

とはいえ、それでカバーできるのは1セクション内の構成までです。
全体の構成や、説明図をどう入れるか、あるいは説明図・表の作成方法というのは誰にも教えられないままの状態で変わりませんから、全体としての読みやすさはあまり向上しないということになります。

とはいえ、テンプレートを使用して、ワードでヘッダ・フッタを付けたり、章題を付けたりするようになると、それぞれの中身に対する理解がしゆすいものになるため、効果がないわけではありません。

ただ、全体を通しての改善には、全体を見通す編集や、そういった業務を経験したことがある人の方が望ましいのは言うまでもありません。

ただ、現在は、そういったことを教えるしくみ、教育システムができていません。
これは、理系と文系をつなく大切なところだと私は考えています。
こういった教育についてもこれから考えていきたいと思います。

マニュアル(取扱説明書)制作の専門家 取説屋:石井ライティング事務所

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です