タグ

ブックマーク / daiyamamoto.hatenablog.com (1)

  • 理解してもらうための文章 10ヶ条 - レベルエンター山本大のブログ

    あなたは12歳の4月1日午前ごろに何を考えていましたか? と聞かれても何も浮かばないが、 中学校の入学式で何を考えていましたか? と聞かれると、様々な記憶が呼び起こされる。 人間は、仕様や定義、数値といった情報を理解するようには出来ていない。 だから、読んで理解するための書き方と、物事を定義する文章の書き方は異なる。 定義する書き方の文章とは、たとえば設計書だ。矛盾が無く、漏れが無いことを重んじる。 また、書き手の個性が反映されてしまうと成果物として成り立たない場合があるので判で押したような文章で書く。 でないと書き手が変わったときにニュアンスを合せるのに苦労する。 しかしながら、こういった文章は読みにくいし理解しにくい。 最近僕は、作ったプログラムを説明するドキュメントを書いている。 これは設計書のように形式的なものではなく、 理解してもらうことが唯一の目的というドキュメントだ。 読んで

    理解してもらうための文章 10ヶ条 - レベルエンター山本大のブログ
    kdoya
    kdoya 2011/05/29
    飛ばし読みを考慮する、見出しとその次の行で8割まで説明する
  • 1