プログラミング演習におけるレポート作成要項

1 レポートの形式

レポートの内容は以下の形式に従うこと.

  1. 体裁
    • 印刷時に A4用紙片面使用・横書き・上綴じとなるようにすること.
    • 表紙には,氏名,学籍番号,教科名,課題名,出題日,提出日,締切日を記入すること.
    • 本文の幅は,A4 で 16cm 前後とし,余白の大きさに注意すること.
    • 本文やプログラムリストが印刷範囲から出てしまい,端が切れている事が多いので, 注意すること.減点の対象,あるいは採点されない場合がある.
  2. 章立て
    1. 概要 (何を解くのか,どういう結果が得られたか)

      レポートは, それ単体で1つの技術文書として完結 していること. つまり,教員が示したレポート課題や問題を別途参照しなくとも, 情報工学の知識があれば理解できるように記述する. そのため,レポートの問題文も省略せずに概要に入れること.

    2. プログラムの作成方針

      何を重視してプログラムを記述すべきかを説明すること. プログラム作成例や記述例を教員が示すことがあるが, 方針を「例題の通り記述する」などとせず, そのプログラムを理解した上で,そのプログラムが重視している事や 作成の方針として説明を受けた事を学習して,汲み取った内容を記述すること.

    3. プログラムリストおよび,その説明

      適宜コメントを入れること. 過剰なコメントは避けるべきであるが, 学習過程においては,気にせず多目に入れておくことを勧める. 行番号を付けて,文書から参照しやすいようにすること.

    4. プログラムの使用法 (マニュアル)

      最低限,起動の方法,入力の形式と方法,出力の読み方を入れること.

    5. プログラムの作成過程に関する考察

      まず,プログラムは,方針通りに作成できたか記述する. 方針どおりにできなかった場合は, どこに原因がある(ありそうか)を説明すること. 改善の余地があったかについて考察する.

      作成方針を実際のプログラムコードとして実現する際には, 多くの場合,いくつかの実現方法があり,いずれかを選択することになる. 自分がしたそれらの選択について説明し, それぞれの選択について,対案ではなく, なぜ今回の方法を採ったのかを説明する.

    6. 得られた結果に関する考察, あるいは設問に対する回答
  3. 構成
    • 各節の記述内容・分量のバランスに注意 (たとえば,「はじめに」で延々と実験結果や数式を用いた説明を行わない).
    • \section コマンドを用いること.
    • 節が長くなる場合には, \subsection , \subsubsection あるいは \itemize で細分化する.
    • 結果出力が分かりにくいものや膨大なものの場合には表やグラフなどの形式で表現する.
    • 長いプログラムリストや結果出力は,タイトルをつけてレポートの最後に回し,本文中では,タイトルで参照するだけにする.
    • 「です」「ます」ではなく,「である」を用いる.
  4. 数式
    • 本文や表中に数式が現れる場合は $ $ で括る.

      たとえば,x 一文字でも $x$ とする,負の数も $-1$ とする.

    • 不等号を不用意に用いると ! や ? が上下反転した記号が現れる.

      _^~ も適切な方法をとらねば正しく表示されない.

    • $$ で囲んだインライン数式で \frac 等を使うのは見苦しい場合が多いので, ディスプレイ数式 \[ \] を用いるか, $a/b$ の様に書く.
    • 添字が 2 文字以上の場合は x_{k+1} のように {} で括らないと表示結果がおかしくなる.
    • 数式の中で,乗算を * 記号で表してはならない. 記号を書かないか,書くなら \cdot\times とする.
    • 数式には \label をつけ,後の文で引用する場合には \ref を用いる.
  5. 図表
    • 図表は,かならず本文中で参照すること. 本文から参照のない図,グラフ,表,プログラムリスト,参考文献は意味がない.
    • 図・図・グラフにはキャプション(タイトル)をつける.図とグラフは下に,表は上につけること.
    • 図の大きさは [scale=0.5] 等として適切に調節すること.
    • \figure, \table などの環境を用い,\caption, \label, \ref を正しく使うこと.
    • 図表は,紙面の上部か下部にまとめ,見やすくすることを心がける. その場合,\begin{figure}\begin{table} のオプションとして t や b を指定すると良い.

      \begin{figure}[tb]
      ...
      \end{figure}
      
    • グラフを書く場合には,何の何に対するグラフなのかをキャプションで説明し, 各軸と単位を明示すること.必要に応じて対数グラフを選択すること.
  6. 計算機の出力やソースコード
    • verbatim 環境を用いること.
    • 行番号を入れて参照しやすいようにすること. (参考資料の .tex 中のコメントを参照).
    • 出力結果を全文省略せずに載せるのは望ましくない.要約すること.
  7. 文献
    • 参考にした資料や本,論文,Webページがあれば,適宜本文から参照すること. (本の内容をレポート中に写すことは,しない)
    • thebibliography 環境を用いる.正しい場所で正しく引用すること. 本文で引用されない文献はリストに入れない.
    • URL の場合は \verb|URL| の様に書くと良い.

参考資料

2 レポートの提出方法

レポートの提出は,各教科の担当教員に従うこと. 一般的には,pdf ファイルを作成し,所定の場所にアップロードする方法や, 紙に印刷して直接提出する方法がある. いずれも,印刷時にA4用紙片面使用・横書き・上綴じとなるように 作成すること.複数のレポートを併合して提出してはいけない.

プリンタの使い方については, http://www.edu.cs.okayama-u.ac.jp/faq/printer.html を参照のこと.

レポートの提出(アップロード)については, http://www.edu.cs.okayama-u.ac.jp/prog/index.html を参照のこと.

以上

日付: 2015-02-18

著者: 乃村 能成