ITの隊長のブログ

ITの隊長のブログです。Rubyを使って仕事しています。最近も色々やっているお(^ω^ = ^ω^)

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

スポンサードリンク

ドキュメントの書き方とか見やすさのテクニックなのかなと思い読み進めていましたが、ペルソナとかカスタマージャーニーマップとかでてくるので、なるほど???って気持ちになりました。ドキュメントの読み手の調査をしっかり行うことであったり、ドキュメントを持って適切にプロダクトを操作、やりたいことが達成できるのか、などの検証を行うべきとあり、結構しっかりしているのなと思いました(全然意識してなかった。。。)

僕個人としては、ドキュメントはあくまでコード読まずとも書いてある内容を実施できたらインストールできるよ。とか、コードだけじゃわからないなぜこの選択をしたのかとかの意味合いで書き残すことが多かったので、その前後を事前調査・検証するということはやってこなかった。そのため、ドキュメントの良し悪しのような物差しも持ってなかったので、あまりテンションもあがらなかった気持ちでした

この本を読むことで良いドキュメントとは?が定義できそうなので、レビューもできるようになれそう

読書メモ

  • ユーザーがドキュメントを読んで達成したいこと、ゴールを定義する
  • ユーザーの特徴をリストアップする
  • ドキュメント書く前にドキュメントのタイトルとゴールとアウトラインを用意する
    • ドキュメントのタイトルはドキュメントを読むことで達成できるゴールの要約したものにすべき
  • 完璧主義からの脱却
  • コンテンツはできる限り短くして要点を絞る
  • ドキュメントをセルフレビューする。チェックリストがあるのはよかった(参考になる)
  • ドキュメントの品質を測る物差しがあることを知れた

ドキュメントもソフトウェアなのだ!メンテしなきゃ!って気持ちになった。良いドキュメント書いていくぞ