テクニカルレポートの書き方01

ryotaroは仕事で何十本もテクニカルレポートを書いてきました。時間はかかりますが、自分の思考を一旦まとめる、他の人に公開する、認知してもらう、などの理由でレポートを作るのは積極的にしていく方が良いと考えます。
書き方は人それぞれでしょうが、自分なりに気にしている観点、コツをまとめます。徐々に、何かの題材を取り上げ、自分のレポートを紹介したいと思っていますが、それは後日。
ryotaroは研究所ではなく製品に近いところにいるため、時間がありません。その中でできるだけ研究所にいるエンジニアに近いレポートのクォリティを出せるよう、日々試行錯誤しています。良いアドバイスがあれば、是非コメントに書き込んで下さい。



~流れ~

①何を書きたいかを決め、情報を集める。

目安は、完成までに必要な情報量の5割くらい。
ひとつのフォルダに、必要なファイルをどんどん溜めていく。他のフォルダに
入っているものを、複製になってしまってもいいから溜めていく。

②漠然とで良いので、結論を2、3箇条書きにして、それに向かって記述を進める。

結論の書き方だが、通常自分は書き始めるタイミングでは数値がまとまって
いない。その為、
「現状の年齢を踏まえると、イチロー選手が今年打率●割●分達成するには、
▲▲トレーニングを■■時間/日 実施することが必須」
のように、数字の部分を目立つ●や■の記号にしておいて、書きながら結論も
深めていく形をとっている。


③ワード・エクセルを使う。

昔からワードが大嫌いで、エクセルやパワーポイントで作っていた。学生時代は
LaTeXも使って書いていたが、2003くらいからワードのクォリティがあがって使いやすくなってきたので、使うようになってきた。章や数式番号の自動ナンバリング機能が無いと、レポートはとても書きにくいので、やはりワープロソフトで書くのがいいだろう。
計算は主にエクセルを使う。それに加え、CやJavaなどの言語を使っている人は使えばいいし、FEMやCFDなど専門的なツールを使っている人はそれをどんどん使って欲しい。
その組み合わせでレポートを作っていく。

④一通り起承転結を書いてみる。


⑤印刷して、赤字でどんどん書き込んでいく。

自分は、校正は画面上では残念ながら行えません。最近経費削減などで印刷代をケチる会社が大半だと思いますし自分の会社もそうですが、こういった作業は躊躇せず印刷するようにしています。

⑥ループ

④、⑤を繰り返す。

⑦上司による校正

⑥のサイクルのどこかで、適当に上司のアドバイスをもらいに行く。ある程度のクオリティはあったほうが良い。そうでないと、本来のテクニカルな議論に入る前に、誤字脱字などの指摘をネチネチとされてしまい、イライラしたりシュンとしたり、いらない気苦労をしないといけなくなる。

⑦結論の数字を入れていく。

だるまの筆入れのような気持ちで。

⑧正式発行







0 件のコメント:

コメントを投稿