技術文書の書き方(1) 要旨と背景


これから何回かにわけて、技術文書の書き方について書いていきます。学会発表のときはもちろん、社内文書でも技術者なら報告書を書くときに技術文書は必須になってきます。

今回は要旨の書き方です。要旨とは、その文章全体に何が書いてあるかをかいつまんで示す文で、短く書きます。その技術を開発するに至った動機や背景、開発した技術の内容、その技術によって得られた効果を短く書きます。技術文書の初めに要旨は書きますが、ワープロソフトが発達しているから、本当に初めに書く必要はありません。本文をざっと書いてしまってから、その要約を要旨として書く方がスムーズかもしれません。自分の書きやすいスタイルで構いません。

ただ、要旨はその技術文書の「顔」のようなもので、読む人はまず要旨を読んで、自分に必要な技術文書であるかを判断し、必要であれば本文も読みます。なので、内容とあまりにもかけ離れた要旨は書かないようにしましょう。

要旨の次は、背景を書きます。自分がこの技術を開発したいと思った動機、社会的背景などを書きます。ソフトウェアの開発は顧客に依頼されてすることが多いかもしれませんが、なぜ顧客はその技術を欲しがったのか考えてみれば、社会的背景もわかってくるはずです。そしてその社会的背景の問題点を解説し、その問題点を解決したいと思ったことを動機とします。

背景を考えるのは、この後の本文を書くことより難しいかもしれませんね。みなさんの普段の仕事に対する考える姿勢を普段から鍛えておく必要があります。ただ、顧客に依頼されたから、上司の命令だから、仕事をするという惰性的な姿勢では、このような文章を書く必要性が出てきたとき、困ってしまいます。開発だけうまくいけばいいのではなく、普段からこの技術は何のためのものか、考えておきましょう。

コメントを残す

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