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

Author(s)

    • Bhatti, Jared バーティ, ジャレッド
    • Corleissen, Zachary Sarah コーライセン, ザッカリー・サラ
    • Lambourne, Jen ランボーン, ジェン
    • Nunez, David ヌーニェス, デービッド
    • Waterhouse, Heidi ウォーターハウス, ハイディ
    • 岩瀬, 義昌 イワセ, ヨシマサ

Bibliographic Information

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

ジャレッド・バーティ [ほか] 著 ; 岩瀬義昌訳

日本能率協会マネジメントセンター, 2023.3

Other Title

Docs for developers : an engineer's field guide to technical writing

Title Transcription

エンジニア ノ タメ ノ ドキュメント ライティング : ユーザー ノ モンダイ カイケツ ト プロダクト ノ セイコウ オ ミチビク

Available at  / 30 libraries

Note

参考文献: p231-235

その他の著者: ; ザッカリー・サラ・コーライセン, ジェン・ランボーン, デービッド・ヌーニェス, ハイディ・ウォーターハウス

Description and Table of Contents

Description

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

Table of Contents

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

by "BOOK database"

Details

Page Top