商品紹介
【内容紹介】
「ドキュメントを書いておけばよかった」
開発者であれば一度は思ったことがあるかもしれません。
ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかった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 ドキュメントの保守と非推奨化
「ドキュメントを書いておけばよかった」
開発者であれば一度は思ったことがあるかもしれません。
ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかった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 ドキュメントの保守と非推奨化
マイメニュー
何か良い本ないかな?
おトクに読める本は?
探してる本はあるかな?
- 詳細検索
- 著者別検索
- 出版社別検索
- 書籍トップ
- 書籍一覧
- ビジネス書・政治・経済
- 小説一般
- 推理・ミステリー小説
- 歴史・戦記・時代小説
- ライトノベル
- コンピュータ・IT
- ホラー・怪奇小説
- SF・ファンタジー小説
- アクション・ハードボイルド小説
- 経済・社会小説
- エッセイ
- ノンフィクション
- 恋愛小説
- ハーレクイン小説
- 英語・語学
- 教育・教養
- 辞書
- 旅行・アウトドア・スポーツ
- 料理・生活
- 趣味・雑学・エンタメ
- 詩歌・戯曲
- 絵本・児童書
- マルチメディア
- 写真集
- ボーイズラブ
- アダルト
- 雑誌トップ
- 雑誌一覧
- ビジネス・政治経済
- 総合週刊誌・月刊誌
- モノ・トレンド
- 男性誌
- 女性誌
- 自動車・乗り物
- コンピュータ・サイエンス
- スポーツ・アウトドア
- エンターテイメント・グラビア
- 暮らし・食・教育
- 趣味・芸術・旅行
- コミック雑誌
- NHKテキスト[語学]
- NHKテキスト[一般]
- 有料メルマガ
- 無料コンテンツ/カタログ
書籍を探す
コミックを探す
雑誌を探す
新聞を探す
リンク
ヘルプ