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

仲田 尚央【著】

ソシム（2024/09発売）

• サイズ A5判／ページ数 304p／高さ 21cm
• 商品コード 9784802614849
• NDC分類 007.3
• Cコード C2055

出版社内容情報

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

内容説明

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

目次

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

著者等紹介

仲田尚央［ナカタナオヒロ］
テクニカルライター、ＵＸライター。主にソフトウェアのＵＩテキストやドキュメント（マニュアル、リリースノートやテクニカルドキュメントなど）を書くことを専門とする。また、それらのローカライズにも携わる。サイボウズでテクニカルライター、ローカライズ部門のマネージャーを務めたのち、２０２４年から現職であるＳｍａｒｔＨＲで活動中。本業の傍らで、企業や学生向けにテクニカルライティングのセミナーを実施。Ｄｅｖｅｌｏｐｅｒｓ　Ｓｕｍｍｉｔ　２０２３アワード受賞。都立産業技術高等専門学校非常勤講師（本データはこの書籍が刊行された当時に掲載されていたものです）
※書籍に掲載されている著者及び編者、訳者、監修者、イラストレーターなどの紹介情報です。