レポート作成ガイドライン Tips に対応
作図とスクリーンショット
レポートに載せる構成図やフローチャートを描く道具と、エビデンスになる画面の撮り方をまとめました。どちらも「読む人に伝わる図」にするための技術です。
作図の道具
ネットワーク構成図やフローチャートは、ガイドラインのTipsで紹介されている次のような道具で描けます。この実験のレポートなら、自分の環境の構成図(Windows PC、Proxmox、仮想マシン、コンテナのつながり)を1枚描いておくと、何度も使えます。
| ツール | 形式 | 費用 | 向いている用途 |
|---|---|---|---|
| draw.io(diagrams.net) | Web/デスクトップ | 無料 | ネットワーク図・フローチャート全般 |
| Lucidchart | Web | 無料(制限あり) | チームでの共同作業 |
| Mermaid | テキスト(コード) | 無料 | Markdownの文書への埋め込み |
| PlantUML | テキスト(コード) | 無料 | UML・シーケンス図 |
| Cisco Packet Tracer | デスクトップ | 無料(要登録) | ネットワーク構成とシミュレーション |
| GNS3 | デスクトップ | 無料 | 本格的なネットワークのエミュレーション |
| Microsoft Visio | デスクトップ | 有償 | 業務で標準的なネットワーク図 |
マウスで描く道具
- draw.io
- 無料のWebアプリ(デスクトップ版もある)。ネットワーク機器の絵柄(アイコン)が豊富で、実験レポートに多い構成図を描きやすい。
.drawio形式で保存でき、PNG・SVG・PDFに書き出せる。Google Drive、OneDrive、GitHubとも連携できる。迷ったらこれ - Lucidchart
- Webで使う作図ツール。無料の範囲では作れる文書の数などに制限があるが、複数人で同時に編集できる
- Microsoft Visio / PowerPoint
- Visioはネットワーク図・フローチャート専用の有償ソフトで、多くの企業で標準になっている。手軽な代わりとして、PowerPointの図形やSmartArtで描く方法もよく使われる。学校のライセンスで使える場合は活用するとよい
文字(コード)で描く道具
図を、決まった書き方の文字で書いておくと、道具が自動で絵にしてくれる方式です。文字なので、修正や、変更の履歴の管理がしやすいのが利点です。
- Mermaid
- フローチャート・シーケンス図・ガントチャートなどを文字で書く言語。
mermaid.liveでは、書きながらブラウザで仕上がりを確かめられる - PlantUML
- UML図(ソフトウェアの設計図)や、ネットワーク図(nwdiag)などを文字で書ける。Javaがあれば手元でも動き、VSCodeの拡張機能で見ながら書ける
ガイドラインにあるMermaidの例と、その仕上がりです。
ファイルの中身Mermaid の書き方の例mermaidエディタで書く内容(ターミナルに打ち込まない)
graph LR
A[PC] -- Ethernet --> B[L2 Switch]
B -- Ethernet --> C[Router]
C -- WAN --> D[Internet]graph LR は「左から右へ流れる図」、A[PC] は「A という名前の、PCと書かれた箱」、-- Ethernet --> は「Ethernetと書かれた矢印」を表す。ネットワークを動かしてみる道具
- Cisco Packet Tracer
- Ciscoが提供するネットワークのシミュレーター。ルーターやスイッチを画面に並べて設定し、データの流れを確かめられる。無料だが Cisco NetAcad のアカウントが必要
- GNS3
- 本格的なネットワークのエミュレーター(オープンソース)。実機に近い環境で試せるが、機器のソフトウェア(Cisco IOSなど)は別に用意する必要がある
このガイドの図について
このガイドの図は理解のために描いたもので、生成AIを使って作成しています。レポートには、自分の環境に合わせて自分で描いた図を載せてください。
Windows 11でのスクリーンショット
エビデンスの画面は、次の方法で撮ります。
| 操作 | 範囲 | 保存のされ方 | 主な保存先 |
|---|---|---|---|
| Win+Shift+S | 範囲選択/ウィンドウ/全画面 | クリップボードにコピー(通知から保存できる) | 保存するときに指定 |
| Win+PrintScreen | 全画面 | 自動でファイルに保存 | ピクチャ\スクリーンショット |
| Alt+PrintScreen | 選んでいるウィンドウだけ | クリップボードにコピー | 貼り付けてから保存 |
| PrintScreen | 全画面 | クリップボードにコピー | 貼り付けてから保存 |
- Win+Shift+S は「切り取りツール(Snipping Tool)」で撮る方法で、撮っただけではファイルになりません。画面右下に出る通知を押し、開いた画面で保存先を決めて保存します
- Win+PrintScreen は、いちばん手早くファイルに残せます。連番で保存されるので、手順を順に記録するのに向いています
- クリップボードに入れる方法(PrintScreen、Alt+PrintScreen)は、PowerPoint・Word・ペイントなどに貼り付けてから、必要なら切り抜いて保存します
Win はWindowsのロゴが付いたキーです。
レポート向けのコツ(ガイドラインより)
- 撮る前に、不要な通知や個人情報(学籍番号、メールアドレス、アカウント名など)が映らないようにする
- 同じテーマの画像はファイル名の付け方をそろえ、
exp2_step01_login.pngのように手順の番号を入れると管理しやすい - 貼る前に必要な部分だけを切り出し、解像度(細かさ)を保つと、読みやすいレポートになる
この実験でのコツ(このガイドからの提案)
- コマンドと結果をいっしょに写す:プロンプト(
t3admin@t3lab-XX:~$など)とコマンドと出力が1枚に入っていると、どの機械で何を実行した結果かが分かる - 撮る直前に画面をきれいにする:
clearまたは Ctrl+L で前の表示を消してからコマンドを実行すると、余計なものが映らない - 文字を大きくする:Windows Terminalでは Ctrl を押しながらマウスのホイールを回すと、文字の大きさを変えられる。縮小して貼ると読めなくなる
- エビデンスの番号でファイル名を付ける:
lab1_ev01_snapshot.png、lab2_ev06_testnet.pngのように、課題とエビデンスの番号を入れると、レポートに入れるときに迷わない - 秘密の情報を写さない:パスワードの入力は画面に出ないが、秘密鍵の中身(
id_ed25519を開いた画面)やProxmoxのログイン情報は写さない - 撮り忘れに気づいたら:多くのエビデンスは、確認コマンドを実行し直せば撮り直せる。ただし「設定の前と後」の比較が必要なものは、設定する前に撮っておく
撮った画像は、図としてレポートに入れ、番号とキャプションを付けて本文から参照します(図表の配置とキャプション)。