【紹介】『ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング』
はじめに
日々の業務において課題を解決するためのドキュメントを作成したり、情報を整理してナレッジウェアツールにまとめたりすることがあります。そのドキュメントは目的を手助けするために作成しているのですが、読みにくいという課題がありました。その課題感を解決する手がかりを得るため - 読み手の目的を手助けするためのドキュメントライティングの知識を獲得するため、本書を手にとりました。
本書ではある会社のプロダクトの開発ドキュメントの作成を通して、読み手を助けるドキュメントライティングの方針やプラクティスを紹介します。この本を読むことで、フィードバックを得てドキュメントを改善していく方法やチームでの展開の仕方も学ぶことができます。またフィードバックのトリアージのガイドラインやドキュメント構成の情報アーキテクチャも紹介しているのですが、より汎用的で再利用可能な知見としてとても重宝します。何かドキュメントを作る必要があるときに手元にあると便利です!
エンジニアのためのドキュメントライティング ユーザーの問題解決とプロダクトの成功を導く
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪う。ユーザーの問題解決とプロダクトの成功を