エンジニアのためのドキュメントライティング : ユーザーの問題解決とプロダクトの成功を導く
著者
書誌事項
エンジニアのためのドキュメントライティング : ユーザーの問題解決とプロダクトの成功を導く
日本能率協会マネジメントセンター, 2023.3
- タイトル別名
-
Docs for developers : an engineer's field guide to technical writing
- タイトル読み
-
エンジニア ノ タメ ノ ドキュメント ライティング : ユーザー ノ モンダイ カイケツ ト プロダクト ノ セイコウ オ ミチビク
大学図書館所蔵 全31件
この図書・雑誌をさがす
注記
参考文献: p231-235
その他の著者: ; ザッカリー・サラ・コーライセン, ジェン・ランボーン, デービッド・ヌーニェス, ハイディ・ウォーターハウス
内容説明・目次
内容説明
なぜ、こんなにドキュメントが軽視されるんだろう？すぐれたドキュメントがなければ、ユーザーに使われる機会が確実に減ります。開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。本書は開発者向けドキュメント作成においてその経験に長けた執筆者たちがドキュメントを作成し、運用する方法をゼロから説明するフィールドガイドです。
目次
- １ ドキュメント作成の準備（読み手の理解；ドキュメントの計画）
- ２ ドキュメントの作成（ドキュメントのドラフト；ドキュメントの編集；サンプルコードの組み込み；ビジュアルコンテンツの追加）
- ３ ドキュメントの公開と運用（ドキュメントの公開；フィードバックの収集と組み込み；ドキュメントの品質測定；ドキュメントの構成；ドキュメントの保守と非推奨化）
「BOOKデータベース」 より