🔖
自分のドキュメンテーション力を上げたくて、「エンジニアのためのドキュメントライティング」を読んでみた
はじめに
「エンジニアのためのドキュメントライティング」という本を読んだので、その内容をまとめます。リンクは以下から。
本の概要
この本は、ソフトウェアの中でも「ドキュメント」にフォーカスした本です。
全十章から成り、計画や作成から運用、品質測定まで一通り記述されています。
よいソフトウェアがあったとしてもそれを学ぶ手段(としてのドキュメント)がなければ、それは成功するのか？
という問いかけから本書は始まります。
総評
通してこの本を読むことで、私たちはモノを作っているのではなく、顧客の問題を解決する方法を作っているのだと改めて感じました。
作って終わりではなく使い方、問題解決の仕方まで伝えてこそ、価値を提供できるということです。
本書はその具体的な方法を示してくれます。
日ごろ、我々はフレームワークやあらゆるサービスにおいてドキュメントに触れ、そこから仕様を理解したり、利用方法を学んだりしています。
自身でサービスやソフトウェアを作っていく場合においても同様で、私たちがフレームワークやサービスに期待するのと同様、ユーザーは我々に対しドキュメントが整備されていることを望むのです。
ソフトウェアは作って終わりではなく、使って初めて価値が出るものである、そのことを考えていきたいと思います。
Discussion