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