[読書レビュー] ドキュメントライティング

2025/01/12

レビュー

t f B! P L
eyecatch 多くのエンジニアが苦手とするドキュメントの書き方をストーリー仕立てで解説してくれている書籍です。 会社員開発時代には、あまりドキュメントを書く事が得意ではなかった自分が、 今ではエンジニアに指導をする事が増えてきたので、評価の高いこの書籍を読んでみることにした。

レビュー

★★★⭐︎⭐︎
この書籍で役にたった情報は、ドキュメント作成のためのツールや、リファレンスサイトなどのリンク集です。 一般的にITサービスを開発している時から、サービスロンチ、公開して、運用をし続けていく過程で、 ドキュメントをどのように書いて更新していくのかが、ストーリー仕立てで書かれていますが、 正直このストーリーから学べることはほぼありませんでした。 ドキュメントを書かないと、どうなるのか? 質のいいドキュメントと質の悪いドキュメントの違いは? こうした本来知りたかった情報は、ありていなことしか書かれておらず、 正直拍子抜け書籍でした・・・orz

ドキュメントも開発の一部?!

この書籍にも書かれていましたが、ドキュメントって開発した人が書く事が一番網羅性が高く、信ぴょう性が高いはずです。 でも、実際はどうではない現場や、個人的な経験からすると、ドキュメントを書くのが上手な人が書いていたり、 運用管理者や、サポート担当者が書くというケースも少なく無いでしょう。 家電製品を買うと、当たり前の様についてくるマニュアルって、読む人がほとんどいないのは、マニュアルとしてのコンテンツの面白さはまるで無いためです。 ここに、マンガマーケティングの様な、読んで楽しいマニュアル思考が入ったり、 ゲームチュートリアルを通して、家電の正確な使い方を覚えるというのは、今時あってもいいはずなのに、何故かこの領域のマニュアルは、 堅苦しい上、見ずらい、分かりずらい、たんなる備え付けの書き物になっているのが現状です。 そう考えると、ソフトウェアドキュメントも、ハードウェアのような製品ドキュメントも、もっともっと向上すべき点があるのではないかと気がつきましたね。 この本を読んだから気がついたのか、この本を読んでさらに自分で考えたから気がつけたのかはよく分からないけど、 一般的なマニュアルという固定概念ってもしかすると、こんごひっくり返るかもしれないよね。

あとがき

この本は、自分のバイブルになるべき本ではなかったですが、いろいろな気付きがたくさんできた本でもありました。 ドキュメントを書くという事に苦手意識を持っている人、 どうやって書いたらいいか分からない人、 よりいいドキュメントを書きたいと考えている人は、 一度くらい目を通してみてもいいかもしれないですが、ドキュメントっていわゆるエンターテイメントコンテンツでもあるんじゃないかと思ってしまったので、 そういう視点で見ると一味違った感想になるかもしれませんね。

人気の投稿

このブログを検索

ごあいさつ

このWebサイトは、独自思考で我が道を行くユゲタの少し尖った思考のTechブログです。 毎日興味がどんどん切り替わるので、テーマはマルチになっています。 もしかしたらアイデアに困っている人の助けになるかもしれません。

ブログ アーカイブ