エンジニアが一生困らないドキュメント作成の基本

ソシム
仲田尚央　

• 価格: 2,420円（本体2,200円＋税）
• 発行年月: 2024年09月
• 判型: Ａ５
• ISBN: 9784802614849

内容情報

[BOOKデータベースより]

ドキュメントを書くこと―それはエンジニアにとって欠かせない仕事です。ドキュメントなしにソフトウェア開発は回りませんし、チームが円滑に回るためにも、ドキュメントによる情報の伝達は必要不可欠です。一方で、エンジニアの皆さんにとって、ドキュメントを書くこと自体は本業でも目的でもないことが多いでしょう。本書では、そんなエンジニアの皆さんが、ドキュメントを書くために手が止まってしまうことのないよう、誰でも、どんなドキュメントでも、「速く」「正確に」「わかりやすく」書ける手順をお伝えします。

基礎編（良いドキュメントを効率良く書くために；ドキュメントの読み方を理解する；読み手とテーマを選定する；テーマを分解する；ドキュメントの骨組みを組む；文章を書く；わかりやすい文を書く；ＣｈａｔＧＰＴで効率良く書く）
実践編（ドキュメントの構成例）

[日販商品データベースより]

「コードを書くのは好きだけどドキュメントは苦手」
「ドキュメントはつい後回しにしてしまう」
エンジニアの皆さん、そんな覚えはありませんか？
本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解説します。
先生役の著者と生徒役をキャラクターにし、全編にわたってイラストを豊富に掲載。
はじめてドキュメントを書くエンジニア、またはこれまで自己流で書いてきたエンジニアが、一度読めば一生使える知識満載です。
装丁画と挿絵は、カケヒジュンさんが手がけます。