hitode909の日記

趣味はマリンスポーツですの日記です

The Product is Docs: Writing technical documentation in a product development group

ドキュメントづくりについて調べているので読んでみた。Splunkって会社の人が書いた、プロダクト開発チームでのドキュメントづくりに関する本。
しっかりテクニカルライター用の本で、編集者をどう採用してチームを作るか、みたいな話も載ってる。ドキュメントづくりにWikiを使う話とかが載っていておもしろかった。

  • ドキュメントが役立っているかどうかどうやって知るのか
    • Analyticsで集計したり、このページは役立ちましたか?ボタンを集計したり
      • チーム内のドキュメントではどうやって集計できるかな、と考えていた
  • Wikiを使ったドキュメントづくりのケーススタディ
    • 全員で編集しても、筆者の会社ではめちゃくちゃにはならなかった、大半の人は誤字を直してくれるくらい、編集者たちはRSSを購読して差分には目を通している
    • OSSのWikiを使って、必要な機能を実装できると良い(PDFを出力できるとか)
  • リモートチームでのドキュメントづくり
    • どうやって仲良くなるかというと、まずは週末の予定とか地元の祝日の話とかする、英語が第一言語でないならチャットやメールを使う
  • カスタマーサポートチームと一緒に働く
    • 毎週のミーティングで、よくお問い合わせを共有して、ドキュメントを直したりする

300ページくらいある英語の本で、全部じっくりは読まずに気になるところだけ目を通す形で読んだ。一度も目に入ってないよりは、ななめ読みでもいいからとりあえず目を通そうとしている。
一度目に入っているということは、そのときに発せられた光線を宇宙の果まで追いかけていって追いついてもう一度網膜に入れればもう一度読めるということなので、遠い未来に科学技術が発達したら役に立つかもしれない。そうはならなくても、Kindleアプリで買っておくと検索できるのが便利。