レポートの書き方#

ツール紹介#

レポートを作成する際に便利なツールを紹介します．

このツールを利用することが必須ではありません．むしろ，自分の方法にあったツールを自分で探す（探す方法を確立する）方がより重要です．

シーケンス図などの UML の図の作成#

シーケンス図などの UML で定義された図を作成する場合は，Illustrator や PowerPoint などのドローソフトで作成しても良いですが，モデリングツールを利用しても良いでしょう．

ネットワーク構成図の作成#

Illustrator や PowerPoint などのドローソフトとルータ等の機材のフリー画像（PowerPoint の場合は「挿入 → ネットワーク画像」から “ネットワーク機器” などのキーワードで検索（クリエイティブ・コモンズライセンスに限定））を使って作成しても良いですが，ネットワーク構成図を作成する機能を持つアプリケーションを使っても良いでしょう．

  • IT エンジニア向け Visio シェイプ

    • MS Visio に同梱されているネットワーク関係のステンシルでも十分だが，特定メーカの機器のステンシルを使いたい場合はここからダウンロード．

  • draw.io(diagrams.net)

    • 新規に作成するダイアグラムの種類から Network Diagram を作成

  • ネットワーク構成図を無料で作成する[アイコン/素材]

    • draw.ioとNetwork Notepadの使い方が簡単に説明されている

  • Cacoo

    • オンライン作図ツール．アカウント登録が必要なものの，100種類以上のテンプレートが搭載されており，簡単に作図が可能．

  • Lucidchart

    • ブラウザ上でネットワーク図を作れるオンラインツール．無料版では最大3つの図しかワークスペースに置けないため，注意が必要．

スクリーンショットの撮り方#

画面のスクリーンショットを撮る場合は OS 標準の方法と専用のアプリケーションを導入する方法があります．機能に多少の違いがありますので，必要なスクリーンショットに合わせて使い分けてください．

レポートにスクリーンショットを貼り付ける場合のファイルフォーマットは PNG にします（JPG のような印刷時に劣化するフォーマットを避けるという意図です）．

PDFの作成#

提出前のチェックリスト#

構成#

  • 使用機材は明記しているか？

    • 最低限，読んだ人が実験を再現できるだけの情報が必要です．

  • グループメンバーのコメントは全て削除されているか？

    • レポートは授業におけるあなたの成果をまとめた文書です．体裁を整えることを忘れずに．

  • 変更履歴は反映されているか？

    • 上記と同じ理由です．

書式#

  • 指定したフォーマットを使用しているか？

    • 学会，会社，行政文書など，すべてに規定されたフォーマットがあります．

    • プリントフォーマットが一致しているだけではなく，ドキュメント上で指定されたスタイルが指定されている必要があります．

  • すべての図と表にキャプションがついているか？

  • すべての図と表は本文中で引用されているか？

  • すべての図と表は本文中で引用されている箇所が明確か？

    • 読者が意図通りの箇所を参照できるような本文中の表現，図・表の表現が必要です．特に図・表に含まれる情報量が過剰な場合，読者は混乱します．本文の論旨に必要な箇所を本文中の図・表とし，全体の情報は付録で提示するなどの工夫を検討してください．

  • 図・表のキャプションの書式は適正か？

    • 図のキャプションは図の下側に配置．

    • 表のキャプションは表の上側に配置．

  • すべての参考文献は本文中で引用されているか？

  • フォントの種類やサイズが統一されているか？

    • 文書全体で 1 つのフォントに統一する必要はありませんが，第 1 章の見出しはボールド体，第 2 章の見出しは明朝体などといった不整合は許容されません．

  • 句読点は統一されているか？ (、。もしくは，．のいずれかに統一すること)

    • 半角のカンマ・ピリオド(, . )を使う場合には直後にスペースが必要です．

文体#

  • 箇条書きを必要以上に多用していないか？

  • こそあど言葉(これ，それ，このなど)を多用していないか？

    • 読者が参照先に迷うため，極力こそあど言葉は避けてください．

    • 具体的な名詞を使って代替することができるはずです．

  • 接続詞(そのため，しかしなど)を必要以上に多用していないか？

    • 接続詞を多用しなければならないときは文章の構成がおかしい場合が多いです．

    • 一般的には接続詞は続く文章を強調したい場合に使います．

  • 必要以上に 1 文が長くなっていないか？

    • 「～し，」という表現を多用していないか？

      • 「～し，」という言葉を使うと一見文章がつながってみますが，実は論理的につながっていない場合が多いです．

      • 「～し，」という表現を使いそうになったら，2 つの文章に分けることができないか考えてみてください．

グラフ#

  • 適切なグラフの種類を選択しているか？

    • 用途に応じてグラフの種類が存在します．例えば，折れ線グラフと散布図は見かけ上類似点がありますが，利用目的が異なります．折れ線グラフは 1 つのものごとの移り変わりを表現する場合（典型的には時系列データ），散布図は 2 つの数値データの関係を表現する場合に採用します．これ以外のグラフについても，用途に合わせて適切なグラフの種類を選択してください．

  • 軸ラベルが用意されているか？

  • 軸ラベルには単位が記載されているか？

  • グラフ中の値を読むことができるサイズ・品質か？

    • 対数表示の利用も選択肢のひとつです．

      • MS Excel の場合は軸の書式設定で「対数目盛を表示する」をチェックします．

graph.jpg

MS Word の参考リンク#

参考文献#