前回に引き続き、全部読まない読書の感想とメモを書いていく。前回記事では1週間で読み切るといいつつ、気づけば2週間経っていることには一旦目を瞑りたい。

2冊目は「エンジニアのためのドキュメントライティング」。

ユーザの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング - Amazon

一週間読書の方法

本の感想に入る前に、どのように一週間読書をやっているかを紹介する。なお、ここで扱う書籍は技術書を中心としたもので、小説などは当てはまらない。

目次から読むところを選ぶ

全部読むことが目的ではなく、短い時間で読みたいところを読むのが目的である。そこで、最初から読み始めないようにしている。ついつい最初から読み始めてしまい、読み切るまでなかなか次の本にいけなくなることを避けるのが狙いである。

目次のページをざっと眺めて、いくつか章を決めて書き留めておく。そして、決めた章のページに飛んで、そこから読み始める。この時、必ずしも数字の若い章から読み始める必要はなくて、読めそうなら一番読みたいところからどこでも読み始めて良い。

最初に決めた章を読み切るか、読むのに一定時間が経ったら(ここで言えば1週間)、その本は完全理解()したとして終わりにし、次の本にいく。

今回でいえば、3, 6, 9章を中心に読んだ。

まとめを活用する

途中の章から読むといっても、前後の文脈がないと難しいときもある。そういう時は、他の章の末尾にある「まとめ」だけを読む。数ツイート分くらいの分量でまとめてくれているので、他の章を読むための概要と文脈が把握できて、読み進めやすくなる。

ここでまとめを読むのはあくまで次の章を読むためで、その章の知識を吸収することはまとめでだけでは大抵難しいことには気をつけておきたい。

メモをとって、感想をまとめる

必須ではないが、感想や学んだことをまとめておきたいので、読みながらページと気になったフレーズをメモしておく(付箋でもよさそう)。読み終わったら、このブログ記事のようにまとめる。

必須にしてしまうと、読むスピードを落としたり、読む障壁になったりするので、メモや感想は必須とはしない。

読みながら感想を書くのも、読む速度を律速してしまうので、単語や1文くらいに留める。一週間後には読み終えるので、その場で丁寧にメモしなくても思い出せるだろう(思い出せなかったら大事ではないだろう)とする。

このような方法で読んでいる。他の方がどのように読書しているかも知りたいので、ぜひアンサーブログで教えていただけると嬉しい。

以降は実際に読んだ書籍の感想が続く。

書籍「エンジニアのためのドキュメントライティング」の感想

免責

  • 上述の通り、この感想記事は本の全部を読んだわけではありません、適宜読み飛ばしながら読んだ人の感想です。
  • ドキュメントライティングについて読んだはずなのに、この記事の文章は微妙だな、と思ったら、チラシ裏のブログ記事として見逃してください。

全体を通して

この本は、全体を通して、ドキュメントを書くときの標準的な方法を、最初から最後まで網羅的に説明している本にみえた(斜め読みだが)。自分の行為が言語化されて体系的に示されるというのは大変よい。これを通して、作業を客観的に捉えられるようになるだろう。

普段やっていることは言語化されて再認識できた。逆にあんまり得意でないところは、書かれていることを順番にやることで、ドキュメントライティング力を底上げしてきたい。

白紙からの脱却

白紙を脱してドキュメントを書き始める方法として、以下のような方法が示されている。

これまでに集めた情報をドキュメントの冒頭にリストアップするところから、ドキュメントを作成開始できます。

  • 読み手
  • 目的
  • コンテンツパターン (p72)

文章を書くとき、白紙の状態から何を書くかまでのアウトラインを決めるところが腰が重い。このフェーズでは「文章を書くぞ」ではなく「リストアップするぞ」と思うことにして、書き始めのハードルを下げるのが大切だと思った。

どんな書き手でも

書き手によらず執筆は難しいものであると、以下のように述べられている。

どんな書き手でも行き詰まります。執筆は創造的で難しい仕事であるため、ときに継続が難しくなりま。行き詰まるのは執筆が下手だからではないのです！アウトライン濁声の最初の段階だったとしても、ドラフトを完成させる途中のどこかであったとしても、行き詰まるのは執筆プロセスの一部です。 (p85)

このあとに続けて、いくつかのTipsが紹介されている。例えば以下のようなものである。

  • 完璧であることを意識せずにとにかく考えを書き出す
  • TODOコメントを活用し、書きづらいところは飛ばす
  • 冒頭ではなく書きやすいところから書く
  • メディアを変える (テキストエディタを変えてみたり、ホワイトボードに書き起こしたり、音声文字起こしを試してみたりする)

「どんな書き手でも行き詰まります。」という言葉はとても勇気づけられる。自分自身、文章を書いていてうまく書けずに行き詰まったとき、「自分はあまり執筆が得意でないのかもしれない」と自分の能力の問題にしてしまうことがある。真偽はおいておいて、それは自分が求めているクオリティを一発で導き出そうとしているのが問題なのではないかと思う。

一発で完璧な完成形を作る必要はない。ソフトウェア開発と同様に、少しずつ改善することで文章を仕上げていけば良いという前提で、執筆に向き合っていきたい。同時にそれは時間がかかることであるので、はやく書き始めるのが大事、大事ですね！

そこそこのボリュームのある文章を書くとき、箇条書きや各章のタイトルの一覧みたいなものを作って書き始めるのだけど、文章の肉付きがないまま箇条書きを完璧にしていくのは結構難しくて、結構行ったり来たり (文章を書いてみて、やっぱり箇条書きに戻る) ということがよくある。書いてみないとわからないということもあるので、まずは脳内をとにかく書き出して、納得いかない個々の部分を直していくという作業に落とし込んでやっていきたい。

最初のドラフトを完成させる

記事の下書きとしてひととおりの文章がかけた時に、全体をチェックする方法として、いかのようなものが挙げられている。

完了したかどうか判断するために、次の質問を自分に問いかけてみてください。

  • 大見出しはドキュメントのゴールを要約しているか？
  • 複数の見出しによってドキュメントは十分に要約されているか？
  • ドラフトは最初から最後まで読み手のニーズに答えているか？
  • 情報の流れは読み手にとって理解しやすいものか？
  • フリクションログで見つけた課題は解決されているか？
  • 何らかのドキュメントパターンやテンプレートに正しく従っているか？
  • 全手順が動作することをテストし確かめたか？ (p91)

ドラフト段階の記事が書き上がるのはとても大きなマイルストーンである。そこまで来れば自分で読み直したりレビューを貰ったりして個々の箇所を改善してけば、文章が完成できる。

ついつい一通り文章がかけると舞い上がってしまって「できた」という気持ちになってしまう。しかし上に書かれたような項目をチェックリストで用意しておいて、このタイミングで満たされているかを確認しておくことで、次のステップで後戻りを減らせるだろう。とてもよいテクニックに思うので実践していきたい。

おわりに

というわけで、1(2)週間読書の第二回でした。2回目があってよかった。忙しさを理由に気づいたらついつい2週間になっていたが、来週こそは1週間で区切りたい。