% 表題: inex レポート評価
%
% 履歴: 2002-02-14 杉山耕一朗
%       2002-02-15 杉山耕一朗
%


■0. はじめに

本ドキュメントでは 2001 年度 北海道大学理学部地球科学科物理実験 I (情
報実験)のレポートに対する講評を行う. 受講生のレポート自体は以下のサイ
トから閲覧することが可能である.

http://www.ep.sci.hokudai.ac.jp/~inex/y2001/rps/index.html 


■1. レポートの体裁

今年はレポート提出期限毎に簡単なレポート講評を行ない, その都度レポート
の書き方指南を行なった. そのかいあってか, 後半のレポートは体裁も整い, 
読みやすくなったと思う. しかし, 正直「まだまだだな」と思う文章も多い.

そこで今回は例を挙げながら, 技術文章を書く上でどのような点を注意してい
くべきか考える.


□1.1 タイトル付け, 段落分けができているか

「中身がしっかりしていれば良いではないか」と考える人も多いかと思うが, 
文章を書く上で体裁は重要である. 特に技術文章の場合にはほとんど読まなく
ても要点がつかめることが求められるので, 適度な段落分け及びタイトル付け
をして文章の構造を見た目にもわかりやすくする必要がある. 目次をつけるこ
とによって文章の構造を明らかにすることも重要である.

見やすい例:
北守君のレポートから
[2.ハードディスクとメインメモリの違い]
■ハードディスク
特徴:磁気によってデータを記憶する。
長所:磁気で記憶しているので電源を切ってもデータが失われることはない。
   (ラジカセの電源を切ってもカセットテープの中身が消えないのと同じ。)
   容量が大きい。
短所:動作が遅い。
■メインメモリ
特徴:半導体を使っており電気的にデータを記憶する。
長所:CPUに直接アクセスできるので処理が高速。
短所:容量が小さい。電気的にデータを記憶させるため電源を切るとデータが失われる。
見にくい例:
深町君のレポートから
1、IDEとはBIOSによって直接制御できるため、SCSIより簡単で低コストである。
  しかし、同時に2台までしか接続することができない。
  また、ハードディスク以上の機器を接続することができない。
  それと、ハードディスクの最大容量が528MBまでに制限されている。
  SCSIとは、アメリカ規格協会によって規格化されている。
  最初の規格はShugart社の開発したSASIをベース。
  現在では凡用性や性能が大幅に強化された後継規格SCSI-2,SCSI-3が普及された。
上記の例は, タイトルと改行を入れることで読みやすくなるはずである. □1.2 比較ができているか 今回のレポート課題の一つは, 「SCSI と IDE の違いを説明せよ」というよう に, 2 つのものを比較をさせるものであった. 比較を行う場合, ・どのような観点から比較を行うのか明らかにする ・ひいきしない. 両者とも同じ程度記述すべき に注意する必要がある.
かなり良い例:
南雲君のレポートから
[1] IDEとSCSIの特徴

     本体(マザーボード)とHDDを接続するのに2つの方法があり、IDEとSCSIである
    <IDEの特徴>
     (1) SCSIに比べて安価だが、1台に接続できる数が最大4台と少ない
     (2) 接続できるのはHDDとCDROMに限られると言う特徴がある
     (3) データ転送は、IDEはUltraDMA/66で66MB/秒.比較的遅い.
    <SCSIの特徴>
     (1) 規格により様々だが、最大接続数は7台(narrow SCSI)または15台(wide 
          SCSI)、さらにスキャナなども接続できるという、IDEに比べて有利な
          点がある
     (2) 新たにSCSIカードを購入しなければいけない
     (3) HDDドライブもIDEより高価で、コストの面でIDEより不利
     (4) データ転送はSCSIがUltra-WideSCSI-3で80MB/秒であり、66MB/秒のIDE
          よも、若干SCSIの方が有利
比較できていない例:
伊藤君のレポートから
1,マザーボードへの取り付け方でIDEとSCSIに分類される。
  SCSIは内蔵と外付けがあるのに対し、IDEは内蔵に限られる。
  以下にもう少し踏み込んで特徴を示す。
  IDEは低コストで簡便に接続できるのだが、同時に二台までしか
  つなげない 、ハードディスク以外の機器を接続できない、ハード
  ディスクの最大容量が528MBまでに制限されているという短所
  もある。
  一方SCSI(スカジー)というのはパソコン本体と周辺機器の
  接続方法の取り決めのことで、seagate technology社開発した
  SASIをベースにしている。SASIは拡張性に乏しかったため
  SCSIが開発され、現在ではSCSI−2やSCSI−3といった
  後継機もでている。
上記の例では, ・IDE: 低コスト, 容量に制限 ・SCSI: パソコン本体と周辺機器の接続方法の取り決め. seagate technology社開発した SASI をベースにしている。 と両者の比較ができていない. □1.3 レポートの問題にちゃんと答えているか 「...を説明せよ」というレポートの場合, 「...」にあたる事象を正確に説明 する必要がある. 例えば「規格」を問われているのならば, その規格は何に用 いられる規格であるか最初に宣言する必要がある. その後, それぞれの特徴を 詳細に議論すれば良い.
答えている例:
志藤君のレポートから
IDEとSCSIの特徴          志藤 文武

  IDEとSCSIはともにパソコンとハードディスク(HD)等の周辺機器を接続するやり方。

 SCSIは、Small Computer System Interfaceの略であり、「スカジー」と読む。
さまざまな周辺機器とパソコンを接続でき、1台のパソコンにつなげられる周辺機器の
数も7〜15台と多めであり、データを転送する速度も速い(IMEの2〜3倍)。しかし、
その汎用性のためか接続にかかるコストが比較的高めである。

 IDEは、Integrated Drive Electronicsの略で、そのまま「アイディーイー」と
読む。基本的にはハードディスクとパソコンとの接続にしか使えず、1台のパソコンに
2〜4台のハードディスクしかつなげず、データを転送する速度は遅い。欠点づくし
とも思われるが、接続にかかるコストが安いという長所をもつ。
答えていない例:
北守君のレポートから
[1.ハードディスクの接続規格SCSIとIDEの特徴]
■SCSI
SCSIボードという専用のボードが必要になるためコストが高い
マルチメディア処理などCPUパワーを使うものに対して適している
HDのほかにもMO、DVDなどいろいろなものに接続できる。
■IDE
SCSIに比べて低コスト。
簡単に接続でき、多くのPCに用いられている。
この規格で接続できるものが少ない
この答え方では, 「接続規格の特徴」の説明になっていません. これでは, 規格 = コストが高い になって, なんのことやらわからない. ■2. 第 3 者の役に立つ文章 第 1 章で述べた体裁の問題は, 技術文章を書く上でまず満たさねばならない ことである. 体裁が整ったならば, 次に吟味すべきは内容となる. 技術文章は第 3 者の役に立つ文章でなくてはならない. ある事象を説明する 文章ならば, それを読むだけでその事象の概念がわかるようにする必要がある. インストールマニュアルならば, それを読むだけで同じ作業ができるようにな ることが必要である. 組み立て分解マニュアルや Linux インストールマニュアルのレポートの時に, 「自分達の失敗を元に, 注意しなくてはならない点をレポートに組み込みなさ い」という指示を出しました. そのような指示は, 次にその文章を読みながら 作業する人がおなじ過ちを繰り返さないようなドキュメントを作れ, というこ とを意味していました.
惜しい例:
福川君のレポートから
[7] Apt Configuration
	ソフトウェア(パッケージ)を全てネットワーク上からダウンロードし、
	インストールすることが出来る。
	この機能を apt というソフトウェアが担っている。

	[7.1] 設定ファイルの編集 

...(中略)...

		すると書かれた設定が正しいかどうか
		(ネットワーク上にそのようなホストがあるかどうか)のチェックが始まる。

		* ここでホストに接続できなかった。
		(長い間「チェック中」の状態が続いたままになった)
		 それはネットワークの設定にてゲートウェイのアドレスを
		 間違って記入していたためであった。

		設定が間違っている場合には、「Fail to fetch」というエラーが出る。
うーん, もうちょっとな例:
樋口さんのレポートから
[13] 一般ユーザの追加
インストール時には「ルート」と呼ばれる管理者用のアカウントしか作っていないので
一般ユーザ用のアカウントを作成する。
作成については情報実験第2回を参照する。

[14] sudo の設定
# visudo コマンドを実行し、以下の 1 行を追加する。 
higuchi ALL=(ALL)ALL 
↑ここにはsudoできるユーザーのアカウント名をいれる。
なかなか良い例:
志藤君のレポートから
【コラム】なぜDHCPを使わなかったのか? 

       DHCPやBOOTPとは「IPアドレス」を多数もっているひと(管理者)が
      「IPアドレス」を貸し出すということを可能にする技術である。
      「IPアドレス」を借りる人(利用者)は、管理者に面倒なネットワーク設定
      などをしてもらえるので楽をでき、管理者は面倒くさがりやな利用者に
      面倒くさいネットワークの説明をする手間が省け、楽ができる。
      「IPアドレス」の数を節約することもできる。
  ...以下省略...
福川さんのレポートの場合, 「チェック中」で動かなくなった後にどのような 点をチェックし, どのように修正したのか書いてあるとなお良い. 樋口さんのレポートの場合, 「アカウントを作る」と言いながら, 実際にどん な作業をしたのか書いていない(その文章だけで全てわかるようにして欲しい). また, sudo の方は何をやったか書いてあって良い. 贅沢を言えば sudo とは 何かを書いておいて欲しかった. 志藤さんのレポートの場合, 注意点をコラムの形にまとめてあり, 非常に読み やすい. ■3. おわりに 第 3 者が読んで意味のわかる文章を書けるようになるのは結構大変です. 文 章を多く書き, また他人の文章を多く読むことが一番の近道です. 受講者の皆さんは普段メールを使っていることと想像します. 文章書きの練習 として「読みやすいメール」を書くことから始めてどうでしょうか. また, 何 が書いてあるか全然わからないメール, 論理構成の狂っているメールを受け取っ た時には, それと同じものを書かないよう気をつけるようにして下さい.