エンジニアのためのドキュメントライティング ユーザーの問題解決とプロダクトの成功を導く

ジャレッド・バーディ(著者), ザッカリー・サラ・コーライセン(著者), ジェン・ランボーン(著者), デービッド・ヌーニェス(著者), ハイディ・ウォーターハウス(著者)

• 販売会社／発売会社: 日本能率協会マネジメントセンター
• 発売年月日: 2023/03/11
• JAN: 9784800590831

商品レビュー

2025/11/05

　ユーザマニュアルの書き方の解説であるが、他の本と一味違うのは公開、フィードバック、メンテナンスまで扱っていること。ドキュメントは多くの場合、作りっぱなしになってしまうが、そうならないようにするにはどうすればよいかというところにまで配慮が行き届いている。作りっぱなしの問題はすでに起きているので対処法は非常に参考になった。また、ドキュメントの管理もプログラムと同様のバージョン管理システムを用いたりするなどプログラマの視点での解説となっており、プログラマとしては非常に理解しやすかった。そして、この解説自体が解説通りの書き方となっており、具体的のどうすればよいのか？にも答えている。ドキュメントの管理もソフト開発と同様にチームで対応する必要があるが個人でできる部分も多々あるので本書を参考に少しずつであっても対応してきたいものだ。

2024/06/23

ドキュメントはあるけど散在していてまとまりがない、そもそもドキュメントってどう作ればいいのか、ドキュメントを作ったけどメンテはどうするべき？みたいな疑問を持ってる人向け。書き方というよりドキュメントの構築〜保守までのやり方が体系的にまとまっている。ドキュメントに携わる人は読むと何かしら学びがあると思う。

惜しむらくは文章の誤字脱字、てにをはの誤用が何箇所か散見されること。一応ライティングに絡む本なのでそのあたりちゃんとしてほしかった…。

2024/04/29

多くの人は本書を
「わかってる」
というだろうが多くの人がこれをわかっていたらわかりにくい文書や文書のないプログラムは世の中に溢れていない