エンジニアのためのドキュメントライティング
<TBD:画像>
基本情報
書籍名: エンジニアのためのドキュメントライティング ユーザーの問題解決とプロダクトの成功を導く
ページ数: 248
金額: 2600円+税
Audible: なし
本の感想
ドキュメンテーションのエッセンスが分かりやすくまとめられていると思いました。
基礎的なことが半分、実践的なことが半分、と感じました。
エンジニアがドキュメント作成に困っていたら、一通り読んでもらうのに丁度良いと思います。
具体的なツールやサービスはほとんど登場しないので、陳腐化しづらいのも良いと思います。
本の概要
PART I ドキュメント作成の準備
CHAPTER 1 読み手の理解
CHAPTER 2 ドキュメントの計画
PARTⅡ ドキュメントの作成
CHAPTER 3 ドキュメントのドラフト
CHAPTER 4 ドキュメントの編集
CHAPTER 5 サンプルコードの組み込み
CHAPTER 6 ビジュアルコンテンツの追加
PARTⅢ ドキュメントの公開と運用
CHAPTER 7 ドキュメントの公開
CHAPTER 8 フィードバックの収集と組み込み
CHAPTER 9 ドキュメントの品質測定
CHAPTER 10 ドキュメントの構成
CHAPTER 11 ドキュメントの保守と非推奨化
お勧めの読者
ユーザー向け技術ドキュメント作成に困っているエンジニア
扱っている分野
ユーザー向け技術ドキュメント
開発時に作る要件定義、設計、仕様、などは主題じゃないので注意。
動機、価格
入手金額: 図書館
入手フォーマット: 紙
動機は満たされたか: はい
関連リンク