Books

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

Jared Bhatti

Product Details

Genre
ISBN/Catalogue Number
ISBN 13 : 9784800590831
ISBN 10 : 4800590833
Format
Books
Publisher
Release Date
March/2023
Japan

Content Description

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

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

【著者紹介】
ジャレッド・バーティ : Alphabetのスタッフテクニカルライターで、Googleのクラウドドキュメントチームの共同創設者。過去14年間に渡ってAlphabetのさまざまなプロジェクトのドキュメント作成に携わってきた。現在はWaymoで技術ドキュメントをリードし、業界の若手ライター数名を指導している

ザッカリー・サラ・コーライセン : Linux Foundationのリードテクニカルライターを経て、現在はStripeの最初のスタッフテクニカルライター。2017年から2021年までKubernetesドキュメントの共同議長を務め、GitHub、Rackspaceを含むいくつかのスタートアップで開発者向けドキュメントに携わってきた

ジェン・ランボーン : Monzo銀行でテクニカルライティングとナレッジマネジメントの分野をリードしている。フィンテック業界に入る前は、英国のGDS(Government Digital Service)のテクニカルライティング責任者として、英国政府内のドキュメンタリストコミュニティをリードしていた

デービッド・ヌーニェス : Stripeのテクニカルライティングの責任者。社内にドキュメントチームを設立し、Increment誌のライターとしても活躍している。Stripe以前は、Uberでテクニカルライティング組織を設立してリードしてきた。またSalesforceではドキュメントリーダーの役割を担っていた。ナレッジプラットフォーム分野におけるスタートアップ数社のアドバイザーも務めている

ハイディ・ウォーターハウス : Microsoft、Dell Software、そして多くのスタートアップで数十年を過ごした。開発者のためのコミュニケーションについて学び、現在はLaunchDarklyで開発者支援者として働いている(本データはこの書籍が刊行された当時に掲載されていたものです)

(「BOOK」データベースより)

Customer Reviews

Comprehensive Evaluation

☆
☆
☆
☆
☆

0.0

★
★
★
★
★
 
0
★
★
★
★
☆
 
0
★
★
★
☆
☆
 
0
★
★
☆
☆
☆
 
0
★
☆
☆
☆
☆
 
0

Book Meter Reviews

こちらは読書メーターで書かれたレビューとなります。

powered by

  • 閑居

    本書では、MDやWikiで技術文書を書く際のライティング手法を紹介している。紹介する手法は、文書の構成や図の書き方からCIやlinterなどのツール紹介までと幅広い。特徴的な手法には、”段階的編集”と”定型化された省力化手法”がある。 段階的編集は、技術、構造、完全性など、観点を絞って、複数の段階に分けて少しずつ文書を執筆する手法だ。 定型化された省力化手法は、gif動画、サンプルコード掲載など、MDやWikiに楽に導入できる鉄板と言えるテンプレを多用して省力化を図る手法だ。

  • kaida6213

    錚々たるメンツによるテクニカルドキュメンテーションのいろは。しかして、そらこれはやるやろという内容が多いのは言うは易しだからだと思う。翻訳が少し読みづらい。

  • リットン

    ドキュメントって、開発者用、設計用のドキュメントじゃなくて、ユーザー向けのマニュアルのようなドキュメントの方の話かい。表紙とタイトルからじゃわからない気がするんだけど、その勘違いするのは僕だけ?。大規模なAPIサービスやフレームワークのドキュメントにはお世話になってるけど、専門家がいるんやな。にしてもstripeのドキュメントはすっごいわかりにくいと思うんだけどな。。。

  • mopinfish

    仕事でドキュメントを集中的に書くタスクが発生したので参考になりそうなので読んだ。ユーザーインタビューを行い仮説を立て、構成を作り、レビューを経て公開し、メンテナンスしていくという工程はソフトウェア開発と同様だなと思いました。技術文書に特化した文章術として参考になりました。

  • Fumi Kawahara

    カタカナ英語多い( ;∀;)日本の一般庶民にとっては、「ドラフト」は野球の「ドラフト」だもんよ( ;∀;)・・・(と、ドラフトのニュースを見ながら)

レビューをもっと見る

(外部サイト)に移動します

Recommend Items