ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング
タイトル:
ユーザーの問題解決とプロダクトの成功を導く エンジニアのためのドキュメントライティング
作 者:
ジャレッド・バーティ/ザッカリー・サラ・コーライセン/ジェン・ランボーン
発売日:
2023-03-11
出版社:
日本能率協会マネジメントセンター
説 明:
【内容紹介】
「ドキュメントを書いておけばよかった」
開発者であれば一度は思ったことがあるかもしれません。
ドキュメントは開発側の生産性とユーザーの利便性を高めるものです。
さらに言うと、ドキュメントがなければ、ユーザーに使われる機会が確実に減ります。
開発者がいかにすばらしいプロダクトを作ろうが、ドキュメントの欠如がその価値を奪うのです。
本書は経験に長けた執筆者たちがドキュメントを作成する方法をゼロから説明するフィールドガイドです。
架空のソフトウェア開発チームのストーリーを追いながら、ソフトウェア開発ライフサイクルの各ステップにおいて、ユーザーニーズの理解、開発者に役立つドキュメントの作成、公開、測定、保守に至るまで、開発を最適化するためのドキュメント作成の技術を解説しています。
これまで学ぶ機会のなかった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 ドキュメントの保守と非推奨化
Recomended Books ミステリー・サスペンス
Recomended Books ノンフィクション
Recomended Books 雑誌
ヤングチャンピオン 2024年05号
志名坂高次/キューライス/カレー沢薫/大和田秀樹/野口賢/佐田正樹/ゆうはじめ/草下シンヤ/山本隆一郎/理央/沢辺有司/酒井義/林いち/高橋ヒロシ/綱本将也/谷嶋イサオ/KEI/今村KSK/田島隆/マサシ/吉田聡/辻裕之/常石爾來也/葉月京/九十九森/六月柿光/平沢バレンティーノ/石原まこちん
別冊少年チャンピオン2024年03月号
増田英二/hiro者/西修/ニャロメロン/いづみかつき/渡辺航/本田真吾/19歳/奥嶋ひろまさ/高嶋栄充/佐藤健太郎/渡辺アカ/林あらた/高橋ヒロシ/きだまさし/たばよう/丈夫大/ルノアール兄弟
モーニング 2024年9号 [2024年2月1日発売]
モーニング編集部/藤本正二/JuanAlbarran/小山宙哉/ツジトモ/綱本将也/濱田轟天/瀬下猛/出端祐大/稚野鳥子/子鹿ゆずる/大槻閑人/森高夕次/川/伊藤一角/亜樹直/オキモト・シュウ/とりのなん子/今村翔吾/立沢克美/須賀達郎/山田芳裕/竹村優作/ヨンチャン/なきぼくろ/糸川一成/池田邦彦/萩原玲二/後藤一信/江口夏実/弘兼憲史/諏訪符馬/福本伸行/NUMBER8/石田点/山村東/石川雅之/矢部太郎
Kindle
無料
Apple Books
無料