『ドキュメント作成の基本』を読む

共有

先日発売の『エンジニアが一生困らない ドキュメント作成の基本』(ソシム)を著者の仲田尚央さんからいただいたので、感想を書きたい。

ITエンジニアであれば、プログラミングやデータベースといった技術知識は当然求められる。しかし組織で働いていると、実はドキュメントを作成する場面は多い。ところが技術知識に比べ、ドキュメント作成の知識を学ぶ機会は少ない。

この背景には「日本語が書けるなら、ドキュメントは書ける」という考え方があるのかもしれない。しかし、実際にはドキュメント作成にはある程度の知識や訓練が求められる。本書はそういったドキュメント作成の基本を解説した書籍となる。


本書の解説で中心となるのは、ドキュメント全体について考えてから実際の文を書くという流れである。これは「ドキュメント作成の5つのステップ」として第1章にある下記の図1-4(p. 33)にまとめられている。

ドキュメント作成の5つのステップ:

  1. 読み手とテーマを選定する
  2. テーマを分解する
  3. ドキュメントの構成を組む
  4. 文章の構成を組む
  5. 文を書く

各ステップの詳細は、本書内の第3章〜第7章でそれぞれ解説されている。そのため、まずこのステップ図さえ頭に入れておけば本書は理解しやすい。そして、ステップ図に沿って考えれば実際にドキュメントを作成する際にも迷子になることはないだろう。

なお、各章の末尾には「まとめ」が置かれている。このまとめで章内の情報が簡潔に解説されていて、忙しい人はまとめだけ読んでもよいと感じた。復習する際にも有用だ。

続く第8章では生成AIについて取り上げている。「構成」(アウトライン)、「下書き」、および「校正」での活用方法が解説されている。生成AIはうまく使えば役に立つとよく分かる具体例も十分に盛り込まれている。


本書は300ページほどあるため、確かにボリューム感はある。しかし前述のように「まとめ」だけをまずざっと読み、必要なところを詳しく読んでもよさそうだ。また、ステップ図をまず頭に入れておけば書籍の内容を理解しやすいし、実際のドキュメント作成も楽にしてくれるだろう。


(いただいた書籍の紹介で自著を挙げるのも厚顔だが、私も『ITエンジニアのための英語ライティング』で、エンジニア向けの英語ドキュメント作成について書いたことがある。重要であるものの、技術知識に比べて注目されにくいドキュメント作成が今後さらに認知されるとうれしい限りだ。)


共有