エンジニアが一生困らないドキュメント作成の基本
発売日:2024年9月
- ページ数
- 303p
- ISBN
- 978-4-8026-1484-9
- 著者情報
- 仲田 尚央(ナカタ ナオヒロ)
テクニカルライター、UXライター。主にソフトウェアのUIテキストやドキュメント(マニュアル、リリースノートやテクニカルドキュメントなど)を書くことを専門とする。また、それらのローカライズにも携わる。サイボウズでテクニカルライター、ローカライズ部門のマネージャーを務めたのち、2024年から現職であるSmartHRで活動中。本業の傍らで、企業や学生向けにテクニカルライティングのセミナーを実施。Developers Summit 2023アワード受賞。都立産業技術高等専門学校非常勤講師
セブン-イレブン受取り(送料無料)
発送目安
発売日(発売日以降は当日)~2日で発送
宅配(送料¥550税込)
発送目安
発売日(発売日以降は当日)~2日で発送
交通状況・天候の影響や注文が集中した場合等、お届けにお時間をいただく場合がございます。
商品説明
ドキュメントを書くこと―それはエンジニアにとって欠かせない仕事です。ドキュメントなしにソフトウェア開発は回りませんし、チームが円滑に回るためにも、ドキュメントによる情報の伝達は必要不可欠です。一方で、エンジニアの皆さんにとって、ドキュメントを書くこと自体は本業でも目的でもないことが多いでしょう。本書では、そんなエンジニアの皆さんが、ドキュメントを書くために手が止まってしまうことのないよう、誰でも、どんなドキュメントでも、「速く」「正確に」「わかりやすく」書ける手順をお伝えします。
目次
基礎編(良いドキュメントを効率良く書くために
ドキュメントの読み方を理解する
読み手とテーマを選定する
テーマを分解する
ドキュメントの骨組みを組む
文章を書く
わかりやすい文を書く
ChatGPTで効率良く書く)
実践編(ドキュメントの構成例)
商品詳細
- 出版社名
- ソシム
- サイズ
- 21cm
- 対象年齢
- 一般
- フォーマット
- 単行本
注意事項
- 本の帯に関して
- 帯つきでの出荷はお約束しておりません。
商品ページに、帯のみに付与される特典物等の表記がある場合でも、確実に帯つきでの出荷はお約束しておりません。
また、帯は商品の一部ではなく「広告扱い」のため、帯の有無・破損による交換や返品は承っておりません。 - 版・表紙について
- 版・表紙(カバー)のご指定は承っておりません。ご注文いただくタイミングによっては、お届けする商品の版や表紙が商品ページ上のものとは異なる場合がございます。
また、初版にのみにお付けしている特典(初回特典、初回仕様特典)がある商品は、商品ページに特典の表記がされている場合でも、無くなり次第終了となります。