|
タイトル |
エンジニアが一生困らない ドキュメント作成の基本(エンジニアガイッショウコマラナイ ドキュメントサクセイノキホン) |
|
「コードを書くのは好きだけどドキュメントは苦手」
「ドキュメントはつい後回しにしてしまう」
エンジニアの皆さん、そんな覚えはありませんか?
本書は、日本語ドキュメントのスペシャリストであるテクニカルライターの著者が、エンジニアが「いつ」「何のドキュメントを」「どうやって」書けばよいのかを、イチから解説します。
先生役の著者と生徒役をキャラクターにし、全編にわたってイラストを豊富に掲載。
はじめてドキュメントを書くエンジニア、またはこれまで自己流で書いてきたエンジニアが、一度読めば一生使える知識満載です。
装丁画と挿絵は、カケヒジュンさんが手がけます。
<基礎編>
Chapter1 良いドキュメントを効率良く書くために
Chapter2 ドキュメントの読み方を理解する
Chapter3 読み手とテーマを選定する
Chapter4 テーマを分解する
Chapter5 ドキュメントの骨組みを組む
Chapter6 文章を書く
Chapter7 わかりやすい文を書く
Chapter1〜7までの振り返り
Chapter8 ChatGPTで効率よく書く
<実践編>
Chapter9 ドキュメントの構成例