レポートの書き方

注意事項

  • よくあるレポートのミス もチェックしておくこと．
  • 付録も含め，表紙を除くすべてのページにページ番号を付けること．
  • 手書き・ワープロいずれで作成してもよいが，手書きの場合は黒のボールペンか万年筆を使用すること．
  • 図・表にはそれぞれ通し番号とタイトルを付けること． なお，番号とタイトルを付けるのは，図の場合は下側，表の場合は上側である．
  • 原則として両面印刷すること． 本来は片面印刷が望ましいが，レポートを構成する紙の枚数が増えると片面印刷ではホッチキス針が閉じず，怪我をしやすくなる．とくに，柔らかいホッチキ ス針 (多くの場合安価) を用いると，レポートの枚数が少なくても閉じられないことが多い．
  • プログラムを実行するための端末への入力や，プログラムの実行結果としての端末への出力を，スクリーンショットとしてレポートに記載しないようにすること． 端末への入力／端末からの出力を，文字として取り扱うこと．

表紙

  • 表紙には，実験時に配布された用紙を使用すること．
  • レポートは左綴じとする (レポートの左側2箇所をホッチキスで綴じる) こと．
  • 氏名，番号の記入には必ずボールペンか万年筆を使うこと．

令和2年度は，Moodle等から題目ごとに配布されるWORDファイルを表紙として用い，WORDファイルとしてソースコードを含むレポートを提出すること．

レポートの構成

レポートは以下に示す構成で書くこと．

  1. 目的

    　実験により何を学ぼうとしているのか，何を明らかにしようとしているのか，何を確認しようとしているのかを簡潔に述べる． 基本的には実験テキストに記載されている目的をそのまま書いて構わない．

  2. 原理

    　実験で用いたアルゴリズムやデータ構造，関数等について概説する． 必要ならば図や表，数式などを使ってもよい． また，実験テキストで 「予習課題」となっている内容 についてもこの節に記述すること．
    　この節に予習課題の内容のみを記載している者もいるが，その場合は 再提出の対象 となる．〆切の都合上でやむなく受理した場合は，原則として減点対象になる．

  3. 装置および方法

    　実験装置と実験方法を示す．
    　具体的には，計算機の仕様やコンパイラ，コンパイルオプション，プログラムの実行方法などを示す． 計算機およびコンパイラに関する記述は，以下のように 表にまとめる こととする．
    　本文では「実験に用いた計算機環境は表1の通りである」などと書くだけでよい． ただし，表1の情報は本資料環境の仕様である．レポートでは，プログラムを実行した環境の情報を記すこと．

    表1．計算機環境
    CPU Intel Core i7 2.8 [GHz]
    OS Ubuntu 18.04.5 LTS
    メモリ 16 [GB]
    コンパイラ gcc ver 7.5.0
    コンパイルオプション -W -Wall

    　つぎに実験内容を説明する．何を調べるため，どのような実験を行ったのかを，実験結果よりも前に説明する． 実験内容は，実験のための具体的操作 (ソースコードを作成して，コンパイルして…）ではない点に注意する．

    　その後，実験方法について説明する．具体的には，作成したソースコードのコンパイル方法とプログラムの実行方法 (とくに，実行時にデータをどの ように入力するか) を説明する．(第3者がここの説明を見ることで，適切にプログラムを実行できなければならない．）
    　コンパイル方法やプログラムの実行方法を載せる場合，「それらの結果を示している端末のスクリーンショットを撮って図として貼り 付ける」ことはしないようにする．

  4. 実験結果

    　実験ごとに，プログラムの実行結果や測定結果を図や表を使って示すこと．結果はなるべく簡潔かつ明確に示すこと．その際，何を実行しているのかを説 明し，その結果によりプログラムの正常動作を確認できていることを示すこと．例えば，プログラムの実行結果を載せる場合，たんに画面出力を貼り付ける だけではなく，赤ペンなどを使って結果部分を明確に示したり，入出力の一覧を表にまとめるなどすることが望ましい．
    　端末に表示された実行結果を載せる場合，「それらの結果を示している端末のスクリーンショットを撮って図として貼り付ける」ことはしないようにする．
    　グラフを載せる場合，グラフも図の一種として扱うことになるので注意すること． グラフでは，必ず 縦軸，横軸のデータの意味を明記する こと．また，物理量には単位も付ける こと． 手書きの場合は必ずグラフ用紙を用いること．代わりにドローツール，プロットツールなどを用いて描画した図を用いてもよい．
    　具体的には，以下のようにプログラムの実行例と得られたデータをわけて記述すると理解しやすい．

    4.1. 実験1

    　ソースコード ex1.c をコンパイルして作成したプログラム ex1 の実行例を図1に示す．

    $ ./ex1
    データ数を入力してください> 5
    5 個の整数をランダムに生成します：
    5987 27971 12141 522 29672
    これらを昇順にソーティングします：
    522 5987 12141 27971 29672
    ソーティングに費やした時間は0.001 秒でした．

    図1. 実験1の実行例

    　図1のようにしてさまざまな数のデータについて実験を行った．結果として得られたデータ数と実行時間との関係を表2，図2に示す．

    表2．実験1によるデータ数と実行時間
    データ数 実行時間 [sec]
    1000 0.5
    2000 1.9
    ... ...
    50000 40.5
    実験1によるデータ数と実行時間の関係

    図2. 実験1によるデータ数と実行時間の関係

  5. 考察

    　実験結果から客観的にいえることを記述する．そして，その結果がどういう意味を持つのかを説明する．
    　もし，結果が理論と一致しない場合は，その原因について考えて記述する．また，ある種のデータ構造やアルゴリズムの実装が目的の実験の場合は，それら の利点や欠点，作成したプログラムの改良点や応用について記述してもよい．
    　内容は，自分で考えたり調べたりすること．調べた場合は出典を必ず参考文献として示すこと． 重要なのは 自分で考えて論じる ことである．たんに Web ページの内容を貼り付けただけのような内容は再提出ないし減点の対象となる．

    ここに感想文 (例えば「クイックソートのプログラムがなかなか動かなくて苦労した」等) を書く者がたまにいるが，この種のレポート (技術文書) には感 想は不要である．将来，自分がどこかの会社へ就職し，職場の上司へ提出する報告書に感想文を付けている姿を想像すれば，レポートに感想を記述すること のナンセンスさを理解できるであろう．

  6. 検討

    　実験テキストで「検討課題」とされている課題について，調べた結果や考えた結果を記述する．図を使うなどしてなるべく分かりやすく書くこと． 　なお，ここの記述が不十分な場合は再提出となる可能性がきわめて高い．

  7. 参考文献

    　実験において自分が参考にした文献をリストアップする． 形式は以下の通りである．

    [番号] 著者名: 文献名，出版社名 (出版年)．
    [番号] 著者名: 文献名，雑誌名，Vol, No, 掲載ページ(出版年)．
    [番号] URL 名 (ページタイトル) (ページを参照した年月日 参照)．
    • 文献番号は，たとえ文献が1つだけでも必ず付けること．
    • 文献番号を囲む記号には [] を使うこと．
    • 文献情報を構成する要素の区切りには，コロン (：)，カンマ (，)，ピリオド (．) を使うこと．
    • 出版年は西暦で書くこと．また「年」は付けないこと．
    • 出版社名に「株式会社」は付けない (省略する) こと．
    • 句読点の後ろに文献番号を付けないこと．
    • 参照したのが Webページの場合は，そのページ (トップページではなく) のタイトル，アクセスした年月日を記入すること．

    　参考文献の例を以下に示す．

    [1] 服部 昌博: C言語とポインタ，工学図書 (1991)．
    [2] 竹井 淳: 衛星を利用したインターネットビジネス，情報処理，Vol.42, No.9, pp.906─911 (2001)．
    [4] http://www.no.exist.net/ (zzzzzマニュアル) (2020年mm月yy日 参照)．

    　本文中ではその文献を参考にした個所に文献番号を付記する． 例えば，「クイックソート」を文献[1]で調べたとしたら，本文中には
    ……………… クイックソート［1] とは，…………
    ……………… クイックソートがある［1]．しかし，………
    などと書く．

  8. 付録

    　実験で作成したソースコードを載せること．この際，レポート本体へソースコードを載せることが難しい場合，それを印刷したものの添付で も構わない． 　本文中では，作成したプログラムの機能 (関数の一覧表など) のみを説明し「ソースコードについては付録を参照されたい」などと書いてお く．ただし，各ソースコードがそれぞれ何のプログラムのソースであるのか分かるように簡単な説明書きも入れておくこと．
    　プログラム以外にもフローチャートや関連する内容があれば付録に記載すること．