出版社内容情報
「ドキュメントを書いておけばよかった」
開発者であれば一度は思ったことがあるかもしれません。
ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかったREADME、APIリファレンス、チュートリアル、コンセプトドキュメント、リリースノートなど、さまざまな種類のドキュメントの書き方について学ぶことができる一冊です。
ドキュメントを作成している現場のエンジニアやテクニカルライター、プロダクトマネジャーの方に最適の内容です。
内容説明
なぜ、こんなにドキュメントが軽視されるんだろう？すぐれたドキュメントがなければ、ユーザーに使われる機会が確実に減ります。開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。本書は開発者向けドキュメント作成においてその経験に長けた執筆者たちがドキュメントを作成し、運用する方法をゼロから説明するフィールドガイドです。
目次
１ ドキュメント作成の準備（読み手の理解；ドキュメントの計画）
２ ドキュメントの作成（ドキュメントのドラフト；ドキュメントの編集；サンプルコードの組み込み；ビジュアルコンテンツの追加）
３ ドキュメントの公開と運用（ドキュメントの公開；フィードバックの収集と組み込み；ドキュメントの品質測定；ドキュメントの構成；ドキュメントの保守と非推奨化）
著者等紹介
バーティ，ジャレッド［バーティ，ジャレッド］ ［Ｂｈａｔｔｉ，Ｊａｒｅｄ］
Ａｌｐｈａｂｅｔのスタッフテクニカルライターで、Ｇｏｏｇｌｅのクラウドドキュメントチームの共同創設者。過去１４年間に渡ってＡｌｐｈａｂｅｔのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はＷａｙｍｏで技術ドキュメントをリードし、業界の若手ライター数名を指導している
コーライセン，ザッカリー・サラ［コーライセン，ザッカリーサラ］ ［Ｃｏｒｌｅｉｓｓｅｎ，Ｚａｃｈａｒｙ Ｓａｒａｈ］
Ｌｉｎｕｘ Ｆｏｕｎｄａｔｉｏｎのリードテクニカルライターを経て、現在はＳｔｒｉｐｅの最初のスタッフテクニカルライター。２０１７年から２０２１年までＫｕｂｅｒｎｅｔｅｓドキュメントの共同議長を務め、ＧｉｔＨｕｂ、Ｒａｃｋｓｐａｃｅを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた
ランボーン，ジェン［ランボーン，ジェン］ ［Ｌａｍｂｏｕｒｎｅ，Ｊｅｎ］
Ｍｏｎｚｏ銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のＧＤＳ（Ｇｏｖｅｒｎｍｅｎｔ Ｄｉｇｉｔａｌ Ｓｅｒｖｉｃｅ）のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた
ヌーニェス，デービッド［ヌーニェス，デービッド］ ［Ｎｕｎｅｚ，Ｄａｖｉｄ］
Ｓｔｒｉｐｅのテクニカルライティングの責任者。社内にドキュメントチームを設立し、Ｉｎｃｒｅｍｅｎｔ誌のライターとしても活躍している。Ｓｔｒｉｐｅ以前は、Ｕｂｅｒでテクニカルライティング組織を設立してリードしてきた。またＳａｌｅｓｆｏｒｃｅではドキュメントリーダーの役割を担っていた。ナレッジプラットフォーム分野におけるスタートアップ数社のアドバイザーも務めている
ウォーターハウス，ハイディ［ウォーターハウス，ハイディ］ ［Ｗａｔｅｒｈｏｕｓｅ，Ｈｅｉｄｉ］
Ｍｉｃｒｏｓｏｆｔ、Ｄｅｌｌ Ｓｏｆｔｗａｒｅ、そして多くのスタートアップで数十年を過ごした。開発者のためのコミュニケーションについて学び、現在はＬａｕｎｃｈＤａｒｋｌｙで開発者支援者として働いている（本データはこの書籍が刊行された当時に掲載されていたものです）
※書籍に掲載されている著者及び編者、訳者、監修者、イラストレーターなどの紹介情報です。
感想・レビュー
※以下の感想・レビューは、株式会社ブックウォーカーの提供する「読書メーター」によるものです。
閑居
リットン
Fumi Kawahara
Q
小泉岳人
