IT pass HikiWiki - 簡単なレポートの書き方指南 Diff

* 第三者が読んでわかる文章を

  きちんとした日本語が書けるようになることは言うまでもない.

  しかるに, 日本の多くの人は, 幼稚園以来, 第三者が読んでわかる文
  章を書くトレーニングを受けたことがない. 先生と生徒という関係に
  甘えた文章しか書いた経験のない人がほとんどではなかろうか. 相手
  が圧倒的な知識をもっていて, 多少文脈がいい加減になっていても,
  何を言いたいのか読み手が解釈して補ってしまっていたに違いない.
  それでは, 情報伝達訓練にはならない.

  第三者が読んでわかる文章とは, そのような先生相手の文章ではなく
  て, 逆に, 自分が知識生産者(先生)になって人に知識を伝えることを
  想定した文章である. 自分が知っている知識を, それを知らない同級
  生に伝えることを想定して書けば良い.

* 技術文章を書く

  技術文章とは, じっくり読まないと理解できない文章でなくて, ほと
  んど読まないでも要点がつかめる文章でなければならない. 知ってい
  る読者は自分の知っている部分を読み飛ばせるように書いてある必要
  があり, できるだけ早く簡潔に必要とされる情報部分が捜し出せ, 切
  り出せるようになっているのが望ましい.

* 情報源を明確にする

  技術文章の絶対にして最低の作法は情報源を明確にすることである.
  
  (1) 他からもって来た事実や概念は, 他に敬意を表するのが
      礼儀である.

  (2) 問題が発生したときに原因の切り分けを明解にする. 自
      分が間違っていたのか情報源がおかしかったのかがわか
      るようにすること.

  より詳しく参照したくなったとき, 問題が発生して原因を追求しなけ
  ればならなくなったとき, などなどに, 情報源のトレースを行いやす
  くするために明瞭なポインターをつけておく必要がある.

  自分で考えたこと, 発見したことでない概念やデータなどに関しては,
  その都度その場で参照しなければならない.

  最後に参考文献を書いておくことは当然であるが, それだけでは不十分.

* 体裁に気を配る.

  書きなぐり調は論外.

* タイトル

  中身と一致させる.

* セクションわけ

  長い文章は, 小説風にべたに文章が書き連ねるのは論外.

* 段落わけ

  段落にわけられているけれども, 段落のキーセンテンスがすぐには見
  付からない書き方になっていると, これまた技術文章としては失格.

  セクションの最初の段落を読めばそのセクションでは何が書かれて
  いるかが理解され, 各段落の最初の文を読めばその段落で何が書かれ
  ているかがわかるようになっているのが良い. (段落の最後でまとめ
  るという流儀もあるがいずれにせよ流儀が直ちにわかるように書くこ
  と)

  このように構造化して書くことで, 読みとばし可能な技術文章にしあ
  がるはず.

* 系の設定, 概念の導入

  これまで知識を持った人に対する文章しか書いたことがないので, 何
  を既存の知識としてどこからはじめるのか, の記述が不明瞭になる傾
  向がある.

  読者に, 何を知っていれば良いのか, 何を前提にしてはじめるのか,
  がわかるように導入をきちんと付ける.

  読者が想定するべき前提は何? という問題.