【書評】エンジニアのためのドキュメントライティング_第一印象
2023-04-07
azblob://2023/04/07/eyecatch/2023-04-07-Docs-for-Developers-FirstImpression-000.png

はじめに

”ITエンジニア” といえば、先ず、黒い画面に向かってコードをカタカタと打っている姿イメージするかもしれません。

私自身、ITエンジニアになる前は上記のようなものをイメージしていました。

しかし、実際にITエンジニアと呼ばれる職についてみて思ったのは、想像以上にドキュメント作成が多い!!

設計書、仕様書、手順書、版数管理、議事録、様々な報告書、その他にもたくさんのドキュメントが必要で、体感”ITエンジニアっぽいこと”の3倍はドキュメント関連の仕事が多いです。(個人の感想です)

『エンジニアのためのドキュメントライティング』概要

ジャレッド・バーティ

ザッカリー・サラ・コーライセン

ジェン・ランボーン

デービッド・ヌーニェス

ハイディ・ウォーターハウス 著

岩瀬義昌 訳

2023年3月30日 発行

本書は、そんなドキュメント作成を作成するうえでよくありがちな、「書き方がわからない」「内容が分かりづらい」と言った悩みを解決してくれる文書のようです。

「ようです。」というのは、まだ読み始めたばかりで、全11章のうち3章までしか読み進められていないからです。

なので、先ずは「第一印象」としてここまでの感想と、どのように書かれているのかを紹介したいと思います。

第一印象

本書は各章の始めに、ストーリーが書かれており、そのストーリーを基にドキュメントを書くノウハウを説明しています。

第一に、このストーリーが面白い。

面白いというか、「ありがち~」「わかる~」というような共感しやすいストーリーになっており、"本を読む"をいう第一関門のハードルを下げてくれます。

第二に、とても具体的です。

例えば『課題をグループ化する』という手法だと、どんな基準でグループ化すればいいのか、どこまで絞っていけばいいのかといったところまで記載があり、読者が実践してみるときに「こういう手法があるのは知ってるけどどうやればいいのかはわからない」という状況になりにくいようになっています。

また、ストーリーという題材があるのもあって、一つ一つの手法に対する例も具体的なので、読者の理解を手助けしてくれます。

第三に、細かく分類されているので、「ここだけまた読み返したい!」って思ったときにその部分が見つけやすくなっています。

よくありますよね、大きな分類しか強調されておらず、読み返したい一部分を探し出すのに前後をたくさん読まないと探し出せないこと。

本書は目次に記載されてないより細かい部分も見やすいように強調されており、ぱらぱらっとめくるだけですぐ読み返したい部分を見つけることができます。

まとめ

というわけで、第一印象は「読者に寄り添ってくれて読みやすく、見やすく、分かりやすい!」です。

ちょっと文字数は多いけど、小中学校の教科書ぐらいの読みやすさを感じました!(それ以降の日本の学校通ってないので高校大学の教科書は知らないけど)

ドキュメント書くに苦手意識のある人や、これからエンジニアを目指す人は、ぜひ読んでみてください。一緒に読んでドキュメントマスターになりましょう!

読み終わったらまたちゃんと書評書こうと思います。

以上、ありがとうございました。

azblob://2024/04/08/eyecatch/2024-04-04-yellow-apron-000.jpg
2024/04/15
About FIXER