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

著者名：ジャレッド・バーティ【著】/ザッカリー・サラ・コーライセン【著】/ジェン・ランボーン【著】/デービッド・ヌーニェス【著】/ハイディ・ウォーターハウス【著】/岩瀬義昌【訳】

日本能率協会マネジメントセンター（2023/03発売）

• ISBN：9784800590831

内容説明

【内容紹介】
「ドキュメントを書いておけばよかった」

開発者であれば一度は思ったことがあるかもしれません。

ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。

本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかった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　ドキュメントの保守と非推奨化

感想・レビュー

※以下の感想・レビューは、株式会社ドワンゴの提供する「読書メーター」によるものです。

[閑居]

本書では、MDやWikiで技術文書を書く際のライティング手法を紹介している。紹介する手法は、文書の構成や図の書き方からCIやlinterなどのツール紹介までと幅広い。特徴的な手法には、”段階的編集”と”定型化された省力化手法”がある。 段階的編集は、技術、構造、完全性など、観点を絞って、複数の段階に分けて少しずつ文書を執筆する手法だ。 定型化された省力化手法は、gif動画、サンプルコード掲載など、MDやWikiに楽に導入できる鉄板と言えるテンプレを多用して省力化を図る手法だ。

2023/12/17

[kaida6213]

錚々たるメンツによるテクニカルドキュメンテーションのいろは。しかして、そらこれはやるやろという内容が多いのは言うは易しだからだと思う。翻訳が少し読みづらい。

2025/12/08

[リットン]

ドキュメントって、開発者用、設計用のドキュメントじゃなくて、ユーザー向けのマニュアルのようなドキュメントの方の話かい。表紙とタイトルからじゃわからない気がするんだけど、その勘違いするのは僕だけ？。大規模なAPIサービスやフレームワークのドキュメントにはお世話になってるけど、専門家がいるんやな。にしてもstripeのドキュメントはすっごいわかりにくいと思うんだけどな。。。

2024/04/12

[mopinfish]

仕事でドキュメントを集中的に書くタスクが発生したので参考になりそうなので読んだ。ユーザーインタビューを行い仮説を立て、構成を作り、レビューを経て公開し、メンテナンスしていくという工程はソフトウェア開発と同様だなと思いました。技術文書に特化した文章術として参考になりました。

2024/09/05

[Fumi Kawahara]

カタカナ英語多い( ;∀;)日本の一般庶民にとっては、「ドラフト」は野球の「ドラフト」だもんよ( ;∀;)・・・（と、ドラフトのニュースを見ながら）

2023/10/27