最初に確認すべき技術報告書でよくみられるミス
公開日: 2023年5月22日 | 最終更新日: 2024年6月23日
タグ: メールマガジンバックナンバー, 技術報告書, 技術者の上司とは, 技術者人材育成
当社で支援する企業、並びに研修で指導する技術者に対して技術報告書の確認をすることがあります。
作成スキルは個人によりばらつきはあるものの、技術者が作成した技術報告書にはある一定の傾向があるのも事実です。
今回は技術報告書を作成するにあたり、多くの技術者がミスをする箇所を念頭に最初に見るべきポイントについて考えてみます。
最も多いのが図表のキャプションに関するミス
技術報告書でよく見受けられるのは、
「図表のキャプションに関するミス」
です。
具体的にどのようなものがあるのか述べます。
図と表でキャプション位置が異なることを理解していない
キャプションというのは、図表が何を意味しているのかを示すものです。
例えば、
表1 収集したサンプルの重量一覧
図1 合成した化合物AのFT-IRスペクトル
といったものが一例です。
そして、図と表ではキャプションの位置が異なります。
図の場合は下、表の場合は上にキャプションを記載します。
学術論文をはじめ、技術系の文書ではキャプション位置が上記のように決まっているため、ここがまずできているかについて技術報告書の添削者は確認を行うことが妥当です。
キャプションの内容が希薄
キャプションで重要なのは、それを読めば概要を理解できるということです。
技術報告書の作成者である技術者は、図表の意味まで含めて十分に理解しています。
そのため、
「これで通じる”だろう”」
という心理になりがちです。
「図1 温度変化のグラフ」
と書いてある場合と、
「図1 温度変化の回帰分析による予測値と実測値との比較グラフ」
とでは、どのようなグラフなのかということに対する印象が異なるのではないでしょうか。
温度変化のグラフだけでは何を意味しているのか理解が難しいはずです。
よって、技術報告書を確認する際にざっとキャプションに目を通し、必要な情報が最低限記載されているかを見るのが妥当だと考えます。
※参照コラム
図表内の単位記載が抜ける
もう一つ技術報告書を記載する技術者が起こしがちなミスが、
「図表内に単位記載がない」
というものです。
グラフでいえば縦軸と横軸のキャプションに単位が無いというのが一例です。
例えば以下のような記載方法があります。
縦軸:炉内温度[℃]
横軸:経過時間[h]
グラフは上記のように軸の説明をするキャプションの後ろに単位をつけます。
グラフの凡例に単位をつける技術者も見受けられますが、やはり単位は軸のキャプションにつけるのが一般的という理解で問題ないでしょう。
また”数値表記”のある表の場合、
1行目、もしくは1列目に数値の内容を示す文言が入ると思いますが、
その記述の後ろにグラフ同様単位を加筆するのが一般的です。
このようにすると表のセル内の数字すべてに単位を振るという必要が無くなります。
もしくは表で示される数値の単位がすべて同じである場合、表の欄外の右上に、
[mm]
といった形で単位を加筆するのが一案です。
このように記載すれば、表内の数値すべてに欄外の単位が適用されると読者に理解させることが可能になります。
いかがでしたでしょうか。
技術報告書は当然ながら中身の文章に加え、データの正確性やわかりやすさが重要ですが、それ以前に理解すべきは今回ご紹介したような初歩的なミスがあると技術報告書としての品質が大きく低下するということです。
添削や確認の対象にさえならない(言い換えれば、添削する価値が無いという判断をされる)可能性もあります。
特に技術報告書作成者が初級者の場合、上記のようなミスが無いよう徹底した教育を行い、技術報告書の最低品質を引き上げるということが重要になると考えます。
本コラムに関連する一般的な人材育成と技術者育成の違い
技術報告書は作成するスキルはもちろんですが、
添削するスキルも重要です。
よって、リーダーや管理職も技術報告書の添削方法を理解することが求められます。
当社では技術者育成コンサルティングのメニューの中で、
中長期にわたってリーダーや管理職の技術報告書の添削に関する指導と支援を行い、
技術報告書作成業務を定常業務に落とし込むサポートを行っています。
これについてより詳細をお知りになりたい方は、
業務報告に関する一般的な人材育成と技術者育成の違いのサイトをご覧ください。
技術者育成に関するご相談や詳細情報をご希望の方は こちら
技術者育成の主な事業については、以下のリンクをご覧ください: