目次

PART I　ドキュメント作成の準備
CHAPTER 1　読み手の理解
CHAPTER 2　ドキュメントの計画

PARTⅡ　ドキュメントの作成
CHAPTER 3　ドキュメントのドラフト
CHAPTER 4　ドキュメントの編集
CHAPTER 5　サンプルコードの組み込み
CHAPTER 6　ビジュアルコンテンツの追加

PARTⅢ　ドキュメントの公開と運用
CHAPTER 7　ドキュメントの公開
CHAPTER 8　フィードバックの収集と組み込み
CHAPTER 9　ドキュメントの品質測定
CHAPTER 10　ドキュメントの構成
CHAPTER 11　ドキュメントの保守と非推奨化 

エンジニアのためのドキュメントライティング - JMAM 日本能率協会マネジメントセンター 「人・組織・経営の変化」を支援するJMAMの書籍 より

感想

ドキュメントをよりよく書くにはということを考え、本書を読んでみました。読み手のことを意識することが大事だといことは理解していたものの、具体的にどうすればいいのかというのはいまいちわかっていなかったので、PART1 が参考になり、改めて読み手のことを意識してドキュメントを書いていこうと思いました。

PART2については、あまり得られるものがなかったかなと思いますが、あまりドキュメントを書く機会がない人向けにもおすすめできそうだなと思いました。

PART3については、ドキュメントの運用面について、これまであまり考えていないことがあり、CHAPTER 9 のドキュメントの品質測定については、現在の現実的には難しそうだなと思いましたが、ドキュメントの品質を高めるためにはどうすればいいのかというのは考えていきたいと思いました。

PART1 と PART3 が特に参考になったため、今後ドキュメントを書く際に参考にしていきたい。