エンジニアのためのドキュメントライティング | 誠品線上

エンジニアのためのドキュメントライティング

內容簡介

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

作者介紹

作者介紹 ジャレッド・バーディJared BhattiAlphabetのスタッフテクニカルライターで、Googleのクラウドドキュメントチームの共同創設者。過去14年間に渡ってAlphabetのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はWaymoで技術ドキュメントをリードし、業界の若手ライター数名を指導している。ザッカリー・サラ・コーライセンZachary Sarah CorleissenLinux Foundationのリードテクニカルライターを経て、現在はStripeの最初のスタッフテクニカルライター。2017年から2021年までKubernetesドキュメントの共同議長を務め、GitHub、Rackspaceを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた。ジェン・ランボーンJen LambourneMonzo銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のGDS(Government Digital Service)のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた。

商品規格