レポートの体裁と章立て - 2024システムプログラミング
レポートの体裁と章立て
レポートは,以下の形式に従うこと.また,TeX でのレポート作成方法 (数式の書き方や図表の入れ方) については,先立つ演習科目で学習した「LaTeXによるレポート作成の基本」を踏襲すること.
体裁
- 印刷時に A4用紙片面使用・横書き・上綴じとなるようにする.
- 表紙には,氏名,学生番号,教科名,課題名,出題日,提出日,締切日を記入する.
- 本文の幅は,A4 で 16cm 前後とし,余白の大きさに注意する.
- 本文やプログラムリストが印刷範囲から出てしまい,端が切れている事が多いので, 注意すること.減点の対象,あるいは採点されない場合があります.
章立て
演習科目によって,レポート全体として 1つの課題を扱う場合はもあれば,システムプログラミングのように レポート内に複数の比較的独立した課題を扱う場合もある.
システムプログラミングでは,課題毎に以下の事を考慮して節を立てること.
プログラムの作成を伴わない課題もあるので,問題解決と読み換えるなど,適宜変更してよい.
概要 (何を解くのか,どういう結果が得られたか)
レポートは, それ単体で1つの技術文書として完結 している必要がある. つまり,教員が示したレポート課題や問題を別途参照しなくとも, 情報工学の知識がある者が読めば理解できるように記述すること.
そのため,レポートの問題文も省略せずに概要に入れること.
プログラム作成 (課題解決) の方針
何を重視して (どのような知識をもって) プログラム作成すべきかを説明すること.
プログラム作成例や記述例,ヒントを教員が示すこともあるが,方針を「例題の通り記述する」などとせず, そのプログラムを理解した上で,そのプログラムが重視している事や作成の方針として説明を受けた事を学習して汲み取った上で内容を記述すること.
プログラムリストや得られた結果,および,その説明
プログラムリストには,適宜コメントを入れること. 過剰なコメントは避けるべきですが,学習過程においては,気にせず多目に入れておくことを勧める.
また,リストには行番号を付けて,文書内から参照しやすいようにすること.
プログラムの使用法 (マニュアル)
起動の方法,入力の形式と方法,出力の読み方を最低限入れること. プログラム実行に際して何らかの引数や操作を必要とする場合には,その説明も必要である.
プログラムの作成過程や問題に関する考察
まず,プログラム作成や問題解決は,方針通りにできたかを記述する. 方針どおりでなかった場合 (こういう場合も多い) は, どこに原因がある(ありそうか)を説明することで,よりよい考察になる. あるいは,改善の余地や別の方法についても考察する.
作成方針を実際のプログラムコードとして実現する際には, 多くの場合,詳細において複数の実現方法があり,いずれかを選択することになるので, 自分がしたそれらの選択について説明し, それぞれの選択について,なぜその方法を採ったのかを説明すること.
- 得られた結果に関する考察, あるいは設問に対する回答