エンジニアのためのドキュメントライティング(エンジニアノタメノドキュメントライティング)

Name: エンジニアのためのドキュメントライティング
Author: ジャレッド・バーディ/ザッカリー・サラ・コーライセン/ジェン・ランボーン/デービッド・ヌーニェス/ハイディ・ウォーターハウス/岩瀬 義昌
ISBN: 9784800590831

著者:: ジャレッド・バーディ/ザッカリー・サラ・コーライセン/ジェン・ランボーン/デービッド・ヌーニェス/ハイディ・ウォーターハウス/岩瀬義昌(ジャレッドバーディ/ザッカリーサラコーライセン/ジェンランボーン/デービッドヌーニェス/ハイディウォーターハウス/イワセヨシマサ)
出版社:: 日本能率協会マネジメントセンター
出版日:: 2023年03月11日
ISBN:: 9784800590831
価格:: ¥2,860
在庫:: 1
判型:: 単行本

★★★★☆4.33(6 件)

言及数

188位

総合

251位

↓ 1 ランクダウン21 件の言及

中級者向け

ドキュメントライティングソフトウェア開発APIドキュメンテーションREADMEチュートリアルコンセプトドキュメントリリースノートテクニカルライティングプロダクト開発ユーザー体験

Amazon で見る楽天ブックスで見る

書籍紹介

「ドキュメントを書いておけばよかった」

開発者であれば一度は思ったことがあるかもしれません。

ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。

本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかった README 、 API リファレンス、チュートリアル、コンセプトドキュメント、リリースノートなど、さまざまな種類のドキュメントの書き方について学ぶことができる一冊です。

ドキュメントを作成している現場のエンジニアやテクニカルライター、プロダクトマネジャーの方に最適の内容です。
PART I ドキュメント作成の準備
CHAPTER 1 読み手の理解
CHAPTER 2 ドキュメントの計画

PART2 ドキュメントの作成
CHAPTER 3 ドキュメントのドラフト
CHAPTER 4 ドキュメントの編集
CHAPTER 5 サンプルコードの組み込み
CHAPTER 6 ビジュアルコンテンツの追加

PART3 ドキュメントの公開と運用
CHAPTER 7 ドキュメントの公開
CHAPTER 8 フィードバックの収集と組み込み
CHAPTER 9 ドキュメントの品質測定
CHAPTER 10 ドキュメントの構成
CHAPTER 11 ドキュメントの保守と非推奨化