文書に興味がある。論文、手順書、リリースノート、レジュメなどクールな文書が存在している。それらの良さはウェブ上で公開されたときの美しさであったり、書き口の良さであったりする。自分の興味の在処を探りながら、再現するにはどうすればいいかを考えてみたいと思う。
ドキュメントの種類とその性質
論文
大学時代には多くの論文を読み、そして自分でも論文を執筆した。ラボのボスのオーケーをもらうまで何度も書き直したし、査読のある論文では適当に書くことは許されない。分野にもよるが、論文には厳密性や再現性が求められる。ものごとを過不足なく伝えて、読んだ人が（リソースさえあれば）再現できるように書いてあるべきだ。また、投稿先に応じてフォーマットが決められていて、ルールにしたがって書く必要がある。特に参考文献（bibliography）の厳格さが好きだった。
手順書
これはほとんど公式ドキュメントを指している。ミドルウェアやソフトウェアを使うときに参考にするドキュメントは、製作者によって大きく異なる。書いてある通りに読めばやりたいことを実現できるものもあれば、説明が足りていないものもある。利用者の専門性にばらつきがあることを考えると読者を想定して書くことがより重要になってくる。これらはウェブで公開されているものが多く、そのデザイン性も注目したいところだ。
あるいは仕事での作業内容を同僚や後輩に引き継ぐときの資料もこれにあたる。ナレッジ共有文化が進んでいるコミュニティではある程度レギュレーションが定められていたり、レビューを通すこともあるが、そうでないところのほうが多い。ルールが決まっていない中で誰にでも分かるように手順書を残すのは難しい。
リリースノート
サービスやアプリの更新履歴は、リリースノートや change log として世の中に公開される。機能追加やバグ修正などがまとめられる。企業によってはエンジニアの遊び心が現れるようなリリースノートもある。これらもウェブ上で公開されていてデザインにも興味がある。
レジュメ
これは履歴書に相当する。日本で履歴書というと表組されたものが一般的な気もするが、PDFやウェブで公開されている職務履歴書はフォーマットが自由であることも多い。自分を売るだけあって自信に満ちたレジュメは特にクールだ。
ドキュメントの要素
ドキュメントを構成する要素をひとつずつ考えてみる。
- 表記の統一性
- フォント、フォントサイズ
- 見出し・項目の分け方
- 書き口
- 内容のわかりやすさ
