レポートの作成について（情報工学実験III）

<style> .reveal { font-size: 180%; } </style>  # [実験レポートの執筆における 心構えとヒント](https://hackmd.io/@8wWr5O5-SdmiPKROyvEGtg/B1ihxqTmc) 実験レポートの執筆は，科学技術者に必須のスキルである テクニカルライティング（technical writing）の練習です．文書を作成する基礎力を磨き，最後は良い卒業論文を書いて卒業しましょう． --- # 読者を意識しよう ---- ## レポートの読者は誰ですか - まだ実験をしていない同級生 - １か月前，実験に着手する前の自分自身 **担当教員や専門家を想定しないでください**．上記の人が読者です．ひとつひとつ教えるように解説を書いてください．あなたが実施した実験について一番詳しい人はあなた自身です．たとえ担当教員であっても，あなたが説明しない限り，あなたの実験結果を誰も再現できません． ---- ## 定義（What）と　理由（Why） を徹底的に書こう 読者が抱く疑問の９割は， 「それは何なのか」という定義に関する "What" の疑問と， 実験目的と方法の必然性，結果の信頼性に関する "Why" の疑問です．読者の立場になって，疑問を残さず説明し尽くすように執筆しましょう． ---- ### 【目的】【原理】　方法　　結果　　考察　  - 【目的】(What) - どんな原理や仕組みを実験的に確認するつもりですか． - 実験結果によって裏付けたい**仮説**は何ですか． - 実験的に何を明らかにしたいですか． それを明らかにする意義は何ですか． - 【原理・背景技術】(What, Why) - どのような法則や，技術に関する実験ですか． - なぜその仮説が成立すると予想していますか． ---- ### 　目的　　原理　【方法】【結果】【考察】  - 【方法】(What, How, Why) - 実験の実施には何が必要ですか． - どうすれば，目的の達成に役立つデータが得られますか． - なぜ，その方法で目的を達成できると言えますか． - 【結果】(What, How) - その画像や数値は何ですか．図や表の見方を教えてください． - 【考察】(Why, How) - どの結果をどのように見ると，原理や仕組み・仮説の裏付けを確認できますか． - 裏付けできた・できなかった原因として何が考えられますか． ---- ## 読者に憶測の余地を残さないように (1/2) 「未定義で意味不明だけれど，たぶん○○のことだろう」「なぜなのか分からないけど，たぶんあんな理由だろう」などと読者に憶測させてはいけません．実験着手前の自分を思い出してください．実験に関して，読者は著者ほどの基礎知識がありません．憶測で読ませると，読者は勘違いや理解不能に陥ります．実験をした著者にとって当たり前のことでも，読者はそれを知りません． ---- ## 読者に憶測の余地を残さないように (2/2) 可能な限り定義を書きましょう．「ここで○○とは△△のことである」「△△を○○と呼ぶ」などでも十分なことが多いです．自分が独自で定義した用語ではない場合は，どの分野で定義済みの用語なのかわかるように**出典**を示し，なるべく読者が定義を確認できるようにすることが望ましいです． ---- ## ひとりで作りこまない 実験のシナリオをグループのメンバーと相互確認し，認識を共有しておくべきです．実験を実施したときの条件や設定も，詳細に記録を残して共有することが， **再現性**のある実験の記述に役立ちます．早期発見・早期治療．未完成，部分的にしか書けていない段階であっても，最終版の前の仮レポートをTAや教員に確認してもらうこと． --- # 実験目的と方法を 決めるためのヒント 体験（experience）で終わりにせず，実験（experiment）することを心掛けましょう．実験科目は，科学技術の理解を深める「学習実験」ではありますが，小さなことでもよいので，発見や，疑問の解消を試みる知的好奇心を発揮してほしいです． ---- ## 【目的】実験で何かを明らかにせよ - 「成功すること」「良い結果を得ること」が実験の目的ではない．どのような条件でどの程度の性能が保証される技術なのかをできるだけ「**解明すること**」である． - 解明したい事柄を思いつく限りすべて書き，重要度と，実験の難易度を順位付けする（グループのメンバーと協働するとよい）．重要度が高く，難易度が低いものを選ぶ． - その目的で実験をする**理由**を述べる．それ以外の事柄については実験をしないが，レポートの最後に要検討事項として言及し，どのような結果が予想されるか述べるとよい． ---- ## 【方法】目的の達成を阻む原因を排除せよ - 明らかにしたい性質が現れる（他の性質に影響されない）ように方法を設計すること． - 例えば，想定している原因だけ異なり，それ以外は全く同じ設定条件下で得た結果を比較する． - ある機能だけ無効にした結果から，その機能の効果を検証する (ablation study)． ---- ## 【結果】明らかにしたい性質を量で示せ - 調べたい事柄の性質を定量的に数値やグラフで示す．その性質を表す評価尺度を算出する． - 偶然の結果ではなく，再現可能であること（**再現性**）を示すために，全く同じ条件下で実験操作を繰り返し（反復試行），**統計量**を示す． ---- ## 【考察】予想と事実を比較せよ - 予想や仮説を立てない実験はありえない． - 予想どおりか否かを議論しやすいように実験結果を整理し，グラフや表で可視化する． --- # 書き方の作法の詳細は 資料をご覧ください． - [実験レポートのサンプル](https://github.com/tsakailab/cisexpkit/blob/master/Experiment/Document/report_sample_cover.pdf) - [実験レポートチェックシート]( https://github.com/tsakailab/cisexpkit/blob/master/Experiment/Document/report_checksheet_n.pdf)