基本情報
- 著者名
- ジャレッド・バーディ、ザッカリー・サラ・コーライセン、ジェン・ランボーン、デービッド・ヌーニェヌス、ハイディ・ウォーターハウス 著/岩瀬 義昌 訳
- サイズ
- A5判並製
- ページ数
- 248頁
- 発行/発売
- 2023年3月
- 対象者
- 開発者、エンジニア、テクニカルライター、プロダクトマネージャー
詳細
【内容紹介】
「ドキュメントを書いておけばよかった」
開発者であれば一度は思ったことがあるかもしれません。
ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかったREADME、APIリファレンス、チュートリアル、コンセプトドキュメント、リリースノートなど、さまざまな種類のドキュメントの書き方について学ぶことができる一冊です。
ドキュメントを作成している現場のエンジニアやテクニカルライター、プロダクトマネジャーの方に最適の内容です。
【著者】
ジャレッド・バーティ(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