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

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

• 要旨（「BOOK」データベースより）

  なぜ、こんなにドキュメントが軽視されるんだろう？すぐれたドキュメントがなければ、ユーザーに使われる機会が確実に減ります。開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。本書は開発者向けドキュメント作成においてその経験に長けた執筆者たちがドキュメントを作成し、運用する方法をゼロから説明するフィールドガイドです。

• 目次

  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　ドキュメントの保守と非推奨化

• 内容紹介

  「ドキュメントを書いておけばよかった」
  
  開発者であれば一度は思ったことがあるかもしれません。
  
  ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
  さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
  開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
  
  本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
  架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
  これまで学ぶ機会のなかったREADME、APIリファレンス、チュートリアル、コンセプトドキュメント、リリースノートなど、さまざまな種類のドキュメントの書き方について学ぶことができる一冊です。
  
  ドキュメントを作成している現場のエンジニアやテクニカルライター、プロダクトマネジャーの方に最適の内容です。
  
  図書館選書
  粗末なドキュメントがプロダクトの価値を奪う。経験に長けた執筆者たちが開発者向けドキュメントの作成方法をゼロから説明するフィールドガイド

• 著者紹介（「BOOK著者紹介情報」より）（本データはこの書籍が刊行された当時に掲載されていたものです）

  バーティ,ジャレッド(バーティ,ジャレッド／Bhatti,Jared)
  Ａｌｐｈａｂｅｔのスタッフテクニカルライターで、Ｇｏｏｇｌｅのクラウドドキュメントチームの共同創設者。過去１４年間に渡ってＡｌｐｈａｂｅｔのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はＷａｙｍｏで技術ドキュメントをリードし、業界の若手ライター数名を指導している
  
  コーライセン,ザッカリー・サラ(コーライセン,ザッカリーサラ／Corleissen,Zachary Sarah)
  Ｌｉｎｕｘ　Ｆｏｕｎｄａｔｉｏｎのリードテクニカルライターを経て、現在はＳｔｒｉｐｅの最初のスタッフテクニカルライター。２０１７年から２０２１年までＫｕｂｅｒｎｅｔｅｓドキュメントの共同議長を務め、ＧｉｔＨｕｂ、Ｒａｃｋｓｐａｃｅを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた
  
  ランボーン,ジェン(ランボーン,ジェン／Lambourne,Jen)
  Ｍｏｎｚｏ銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のＧＤＳ（Ｇｏｖｅｒｎｍｅｎｔ　Ｄｉｇｉｔａｌ　Ｓｅｒｖｉｃｅ）のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた
  
  ヌーニェス,デービッド(ヌーニェス,デービッド／Nunez,David)
  Ｓｔｒｉｐｅのテクニカルライティングの責任者。社内にドキュメントチームを設立し、Ｉｎｃｒｅｍｅｎｔ誌のライターとしても活躍している。Ｓｔｒｉｐｅ以前は、Ｕｂｅｒでテクニカルライティング組織を設立してリードしてきた。またＳａｌｅｓｆｏｒｃｅではドキュメントリーダーの役割を担っていた。ナレッジプラットフォーム分野におけるスタートアップ数社のアドバイザーも務めている
  
  ウォーターハウス,ハイディ(ウォーターハウス,ハイディ／Waterhouse,Heidi)
  Ｍｉｃｒｏｓｏｆｔ、Ｄｅｌｌ　Ｓｏｆｔｗａｒｅ、そして多くのスタートアップで数十年を過ごした。開発者のためのコミュニケーションについて学び、現在はＬａｕｎｃｈＤａｒｋｌｙで開発者支援者として働いている

• 著者について

  ジャレッド・バーディ (ジャレッドバーディ)
  Jared Bhatti
  Alphabetのスタッフテクニカルライターで、Googleのクラウドドキュメントチームの共同創設者。過去14年間に渡ってAlphabetのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はWaymoで技術ドキュメントをリードし、業界の若手ライター数名を指導している。
  
  ザッカリー・サラ・コーライセン (ザッカリーサラコーライセン)
  Zachary Sarah Corleissen
  Linux Foundationのリードテクニカルライターを経て、現在はStripeの最初のスタッフテクニカルライター。2017年から2021年までKubernetesドキュメントの共同議長を務め、GitHub、Rackspaceを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた。
  
  ジェン・ランボーン (ジェンランボーン)
  Jen Lambourne
  Monzo銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のGDS（Government　Digital Service）のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた。
  
  デービッド・ヌーニェス (デービッドヌーニェス)
  David Nunez
  Stripeのテクニカルライティングの責任者。社内にドキュメントチームを設立し、Increment誌のライターとしても活躍している。Stripe以前は、Uberでテクニカルライティング組織を設立してリードしてきた。またSalesforceではドキュメントリーダーの役割を担っていた。ナレッジプラットフォーム分野におけるスタートアップ数社のアドバイザーも務めている。
  
  ハイディ・ウォーターハウス (ハイディウォーターハウス)
  Heidi Waterhouse
  Microsoft、Dell Software、そして多くのスタートアップで数十年を過ごした。開発者のためのコミュニケーションについて学び、現在はLaunchDarklyで開発者支援者として働いている。
  
  岩瀬 義昌 (イワセヨシマサ)
  東京大学大学院学際情報学府を修了後、東日本電信電話株式会社に就職。大規模 IP電話開発に携わった後、2014年より現職であるNTTコミュニケーションズにて ソフトウェアエンジニア、テックリードとしてWebRTCプラットフォームの開発 に従事する。その後、人事として全社の人材開発・組織開発を経て、現在は全社 のアジャイル開発・プロダクトマネジメントを支援している。また、個人事業主としても活動しており、ストックマーク株式会社 Co-VPoE(2021～)。早稲田大 学非常勤講師(2020～)。テクノロジーポッドキャストであるfukabori.fm のパーソナリティ。 Twitter: @iwashi86

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