晴耕雨読

working in the fields on fine days and reading books on rainy days

レポート提出前に確認する事

レポート提出前に確認する事のチェックリスト(自分用)です。 今まで数々のレポートと卒業論文を提出してきた経験と、他人のレポートや論文をレビューした経験に基づいて書いています。 主に図、表、数式、アルゴリズム、文章を書くときに気をつけるべきことについてです。

  • その図は必要か(ページ稼ぎになっていないか)
  • 図について本文中で参照されて説明されているか(「図1」)
  • センタリングされているか
  • キャプションは図の下についているか
  • キャプションは具体的に書かれているか (キャプションは読まれる頻度が高いことが統計的にわかっているので)
  • 図は単純・綺麗で論点とは関係ない細部を取り除いているか
  • データは適切な方法でプロットされているか(折れ線・棒グラフなどの使い分け)
  • 図は小さすぎないか(画面と紙では違って見えるので必ず印刷して確認しよう)
  • 図中の字は読みやすい太さ・大きさになっているか(若い子は小さい字も読めるが、歳をとると小さい字が辛くなる)
  • 図の中のラベルや説明文は、本文のフォントと同じ系統が使われているか(レポートや論文なら明朝体、プレゼン資料ならゴシック体)
  • 図の中の数式は、本文の数式フォントと同じ系統が使われているか
  • 重要性が等しい図は同じ尺度で作られているか
  • 全ての略語やシンボルは、凡例やキャプションで説明されているか
  • グラフは横軸が変化させたもので、縦軸が変化したものになっているか
  • グラフの軸の見出しの単位を示すときは (m/s) のように丸括弧を使っているか([m/s] は誤用、詳しくは物理量の次元で検索してください)
  • 写真やスクリーンショットを使うときは、関係ない部分が写っていないか(トリミングするか背景色で塗りつぶす)
  • 写真やスクリーンショットを白黒で印刷したときに、文字などが読みづらくなっていないか(コントラストなどの変更など)
  • 写真やスクリーンショットの背景が黒系なら色の反転をして白系にする(印刷するとき図に黒が多いと汚く見える。コンソール画面のスクショは論外なので、内容をコピーしてテキストにして載せる)
  • 図の中に細過ぎる線は含まれていないか(印刷で消えないか)
  • 拡大してポスターに印刷するとき、図はベクタ形式を使っているか

  • その表は必要か(ページ稼ぎになっていないか)
  • 表について本文中で参照されて説明されているか(「表1」)
  • センタリングされているか
  • キャプションは表の上についているか
  • 文字列は左寄せか中央寄せ、数字は右寄せになっているか
  • 全ての列に列見出しがあるか
  • 小数点の位置は揃っているか(TeX なら \phantom{} コマンドを使いましょう)
  • 指数部分の位置は揃っているか
  • 表の幅はページの横幅にあっているか(横幅がある表は逆時計回りに90度回転させる
  • 効果的な表示方法の選択がなされているか
    • 3個以下の場合は、文章で表現する
    • 4〜20個の場合は、表で表現する
    • 20個より多い場合は、グラフや図で表現する
  • APAスタイルでは垂直罫線を書かないのが一般的
  • TeX なら booktabs を使って垂直罫線の無い表を作ろう(参考:Small Guide to Making Nice Tables (pdf)

数式

  • その数式は必要か(入門書でもない限り、途中式を全て載せる必要はない)
  • 本文中から参照されているか(「式(1)」のように丸括弧をわすれないこと)
  • 数式と文章は分離されているか (「条件から、〜長い数式〜 となる」は読みづらい。代わりに「条件から式(1)となる」のように書く)
  • log, sin, cos などの数学関数はローマン体で書かれているか
  • プログラムの関数名を数式で使うときも、関数はローマン体で書かれているか
  • TeX の場合、関数 cross_entropy() などのアンダースコアの部分が変になっていないか
  • 関数名にハイフンが含まれる場合はマイナスになっていないか(関数 tf-idf() が tf - idf() だと誤解される)
  • 指数表示を 9e9 や 9.1e-31 のように書いていないか(数式としては正しくない)
  • 単位(kg, m/s など)はローマン体になっているか(変数はイタリック体、単位はローマン体)
  • 有効数字は適切か(有効桁数は3桁もいらない)
  • 統計で 1 より大きくならない場合は .25 のように一の位の 0 が省かれているか
  • 文字に対するメタ情報はあるか(「C上のP」ではなく「曲線C上の点P」の方が読みやすい)
  • 文字の使用は慣習に従っているか

    文字 使い方
    $a,b,c,d,e$ 定数
    $f,g,h$ 関数
    $i,j,k,l$ 添字
    $m,n$ 整数や添字
    $p,q$ 整数や素数
    $r,s,t,u,v,w$ 実数やパラメータ
    $x,y,z$ 未知数や変数


アルゴリズム

  • そのアルゴリズムは説明に必要か(番号付き箇条書きで書けないほど複雑であれば、アルゴリズム形式で書く)
  • 本文中から参照されているか(「Algorithm 1」)
  • 自然言語や疑似言語もしくは数式で書くこと
  • 「=」という演算子を代入で使わないようにする(代入には「←」や「:=」がよく使われる)
  • 配列を扱うときに「a[5] := 3」はプログラム言語に依存した書き方なので、代わりに添字を使って「a₅ := 3」と書くこと

文章

  • 必要以上に段落が小さくなりすぎていないか(1行だけの段落がたくさんあるのはよくない)
  • 用語は一貫して用いられているか(サーバ、サーバー、server、Server)
  • 主語は抜けていないか
  • 動詞にできるのに名詞になっていないか(「結果の検証を行う」は「結果を検証する」に変更する)
  • 「という」「こと」が頻出していないか(「抽出するということはできている」は「抽出できている」に変更する)
  • 接続詞はひらがなになっているか(したがって、すなわち、しかし など)
  • 接続詞・副詞・指示語はひらがなの方が読みやすい(もし、たとえば、すべて、すでに、この、その、ある など)
  • 文の繋ぎの「とき」「こと」「もの」はひらがなにする(〜するとき、〜すること、〜するもの)
  • 「が」を逆説ではなく単純接続として使っていないか(「が」は文を長くする原因となる。たとえば「上の図では一つの最大公約数について示した,これが圏である.」は逆説ではなく単純接続として使われている。文を2つに切るべき)
  • 理由を説明するときの接続詞は「ため」か「ので」を使う(「ので」は客観的、「から」は主観的、「ため」は多義語なので使用を避けるべき)
  • 考察で結果を参照するときは「表1より」ではなく「表1から」を使う(「より」には比較の意味もあるので使用を避けるべき)
  • 考察には論理的な流れがあるか(火(結果)の無い所に煙(考察)は立たぬ)
  • 専門用語はきちんと説明されているか(生徒と先生以外のJABEEなどの第三者が読んでもわかるか)
  • 「以下」で参照したものが次のページに存在していないか(pdfで読むときはページが変わっても下にあるように見えるが、印刷して読むときは下にはないことを念頭に置いて文書を作成すること)
  • 「である」調が使われているか(grep 'ます。' *.tex などで確認できる)
  • 命令形が含まれていないか(レポートの読者に対して命令することはないので、課題の内容を写すときは特に注意)
  • 個数を表すときの助数詞は「2つ」ではなく,出来るだけ「2個」「2種類」などを使いたい(助数詞を単純化して何にでも「つ」を使う傾向があるのはよくないため)
  • 章・節・項の見出しは簡潔になっているか(2行以上は読みづらい)
  • 章・節・項の見出しは「〜について」などの冗長な表現が使われていないか
  • 章・節・項が1つだけになっていないか(1つしかないなら章・節・項で分ける必要はない)
  • 章・節・項の見出しの後にはリード文があるか(「この章では〜について述べる」などの導入文を入れる)
  • 参照だけが改行されていないか(TeX なら ~\cite{} と書けばOK)
  • 句読点は「、。」または「,.」に統一されているか
  • 「だ・である」(常体) または「です・ます」(敬体) に統一されているか
  • 疑問符を使っていないか(疑問は「〜か」だけで十分。「?」をつける必要はない)
  • 一文一義になっているか(情報を盛り込みすぎないで、一文を短くすることを心がける)
  • 二重否定、受け身、ぼかし表現を避けて主張を明確にしているか(〜ないわけではない、〜と思われる、〜と考えられる、たぶん、など、は避ける)
  • 「用語の定義」という節または使用する直前に用語の定義はされているか
  • 大して使わない用語も定義していないか(著者の知ったかぶりは読者を混乱させる)

形式

  • 段落最初は字下げされているか
  • 見出しはゴシック体になっているか(特にWordを使う人)
  • 表紙を付けたか(科目名、課題名、学籍番号、氏名、提出日 は少なくとも必要)
  • ページ番号は表紙の次のページから始まっているか(表紙にはページ番号を入れない)
  • 目次のページのページ番号はローマ数字 (i, ii, …)、中身のページのページ番号はアラビア数字 (1, 2, …) になっているか
  • 片面印刷にしているか(片面しかスキャンできないスキャナもある)
  • ホチキスは左上にしているか。量が多い場合はダブルクリップが好ましい
  • レポートでは章と章の間は改ページしてはいけない。卒論の場合は改ページする
  • 本文には10〜11ポイントの明朝体が使われているか
  • 書名の引用をするときは二重カギ括弧『』を使っているか
  • 参考文献は ISO 690 スタイル (またはAPAスタイル) で書かれているか(「著者名. 論文名. ジャーナル名, 発表年.」の順番で書く)