• 本

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

出版社名 日本能率協会マネジメントセンター
出版年月 2023年3月
ISBNコード 978-4-8005-9083-1
4-8005-9083-3
税込価格 2,860円
頁数・縦 242P 21cm

商品内容

要旨

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

目次

1 ドキュメント作成の準備(読み手の理解
ドキュメントの計画)
2 ドキュメントの作成(ドキュメントのドラフト
ドキュメントの編集
サンプルコードの組み込み
ビジュアルコンテンツの追加)
3 ドキュメントの公開と運用(ドキュメントの公開
フィードバックの収集と組み込み
ドキュメントの品質測定
ドキュメントの構成
ドキュメントの保守と非推奨化)

著者紹介

バーティ,ジャレッド (バーティ,ジャレッド)   Bhatti,Jared
Alphabetのスタッフテクニカルライターで、Googleのクラウドドキュメントチームの共同創設者。過去14年間に渡ってAlphabetのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はWaymoで技術ドキュメントをリードし、業界の若手ライター数名を指導している
コーライセン,ザッカリー・サラ (コーライセン,ザッカリーサラ)   Corleissen,Zachary Sarah
Linux Foundationのリードテクニカルライターを経て、現在はStripeの最初のスタッフテクニカルライター。2017年から2021年までKubernetesドキュメントの共同議長を務め、GitHub、Rackspaceを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた
ランボーン,ジェン (ランボーン,ジェン)   Lambourne,Jen
Monzo銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のGDS(Government Digital Service)のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた
ヌーニェス,デービッド (ヌーニェス,デービッド)   Nunez,David
Stripeのテクニカルライティングの責任者。社内にドキュメントチームを設立し、Increment誌のライターとしても活躍している。Stripe以前は、Uberでテクニカルライティング組織を設立してリードしてきた。またSalesforceではドキュメントリーダーの役割を担っていた。ナレッジプラットフォーム分野におけるスタートアップ数社のアドバイザーも務めている
ウォーターハウス,ハイディ (ウォーターハウス,ハイディ)   Waterhouse,Heidi
Microsoft、Dell Software、そして多くのスタートアップで数十年を過ごした。開発者のためのコミュニケーションについて学び、現在はLaunchDarklyで開発者支援者として働いている(本データはこの書籍が刊行された当時に掲載されていたものです)