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

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

ジャレッド・バーティ, ザッカリー・サラ・コーライセン, ジェン・ランボーン, デービッド・ヌーニェス, ハイディ・ウォーターハウス, and 岩瀬義昌

日本能率協会マネジメントセンター / 2023-03-11

累計読者数27
平均ハイライト数 12.6件/人
推定読了時間 約4時間17分
star総合評価 53/100
start序盤集中型
check_circle推定完走率 20%

この本について

プロダクトのドキュメントを書いていると、「これで本当に伝わるのか?」とか「自分には当たり前のことを、どこまで説明すべきなんだろう…」と手が止まることがよくあります。僕もまさにその沼にハマるタイプで、書いては直し、読み返しては迷う、をずっと繰り返してきました。 この本が助かったのは、悩んでいたポイントを “作業レベル” にまで分解してくれたところです。たとえば、フリクションログをつけて自分自身がユーザーとしてつまずく瞬間を拾う方法は、チーム内の「分かったつもり」を壊すのにかなり効きました。また、ハウツーとチュートリアルをどう分けるのか、どの段階で情報をどこまで載せるのかといった構造面の判断も、この本の考え方に沿うと迷いが減ります。さらに、ユーザーは基本的に流し読みしかしないという前提に立つことで、書き方そのものが変わっていきました。 派手なノウハウ本ではなく、現場で「これどうするんだっけ」と悩んだときのよりどころになる一冊です。ドキュメントの質を上げたいけれど、どこから手をつければいいのか迷っている人に特に刺さると思います。

analytics

読書インサイト

ハイライト密度

開始終了

多くの読者は3に最もインサイトを感じており、全ハイライトの29%が集中しています。

読書の順序

この本に似ている本

すべて見る arrow_right_alt
書籍情報(出版社紹介・目次)expand_more

出版社による紹介

【内容紹介】 「ドキュメントを書いておけばよかった」 開発者であれば一度は思ったことがあるかもしれません。 ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。 さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。 開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。 本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。 架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。 これまで学ぶ機会のなかったREADME、APIリファレンス、チュートリアル、コンセプトドキュメント、リリースノートなど、さまざまな種類のドキュメントの書き方について学ぶことができる一冊です。 ドキュメントを作成している現場のエンジニアやテクニカルライター、プロダクトマネジャーの方に最適の内容です。 【目次】 PART I ドキュメント作成の準備 CHAPTER 1 読み手の理解 CHAPTER 2 ドキュメントの計画 PARTⅡ ドキュメントの作成 CHAPTER 3 ドキュメントのドラフト CHAPTER 4 ドキュメントの編集 CHAPTER 5 サンプルコードの組み込み CHAPTER 6 ビジュアルコンテンツの追加 PARTⅢ ドキュメントの公開と運用 CHAPTER 7 ドキュメントの公開 CHAPTER 8 フィードバックの収集と組み込み CHAPTER 9 ドキュメントの品質測定 CHAPTER 10 ドキュメントの構成 CHAPTER 11 ドキュメントの保守と非推奨化
library_books似た本をもっと見るmap書籍マップで探すroute読書パスガイドauto_awesomeAI診断で次の1冊を探す

読んだ内容を、もう忘れない。

BookNotion Zなら、Kindleのハイライトを自動で保存・整理。Notionにエクスポートして、いつでも振り返れます。

無料ではじめる

クレジットカード不要