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

仲田 尚央【著】

ソシム（2024/09発売）

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

出版社内容情報

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

内容説明

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

目次

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

著者等紹介

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

感想・レビュー

※以下の感想・レビューは、株式会社ブックウォーカーの提供する「読書メーター」によるものです。

[ますみ]

基本についてだけどよかった。ほかの人にも読んでもらえるとレビューで楽できるなと思った 。 パラグラフと中心文については自分の言語化が足りておらず指摘で臆することが多かったので使える表現を得られて嬉しい。 ChatGPTでの向き合い方の章で「そうなのよレビューに集中しなきゃなのよ」と思った。真面目に書くと十数分かかるのに数秒で済んでるいるのだから、真剣に書き直すつもりで数分レビューすればいい。「まぁ、いいか」と甘えてしまう自分がいる。

2025/01/19

[安心院]

良いドキュメントを書くために必要なのは設計力だと理解できた。テーマを選定し読者を想定し、アウトラインを組んで言いたいことを並べてから文章を書けば自ずと見通しが良くなるはずだ。私は今まで中心文というものを理解しておらず、そのせいで読みにくいドキュメントをたくさん書いてきたのだろうと改めて思う。もちろん、このパラグラフの中心文は「良いドキュメントを書くために必要なのは設計力だと理解できた。」である(これは結論文)

2025/01/18

[ゆうやけＰＣ]

読みやすく分かりやすい本だったけど、実行するには長い時間がかかりそうだった

2025/03/04

[pea47581220]

文書の設計から記載内容までトップダウンでアプローチする手順を分かりやすく書いていてお勧めできます AIの活用例も書いており、参考になりました

2025/01/12

[_ Nambu _]

How-toより手前の、独習する人向け教科書、という感じ。「一生困らない」かは、独習した結果、どこまで応用力を身につけられるか、個人によるとは思うが。登場人物が3人いるが出てくるのは章の冒頭だけで、大半は「こうしましょう」の説明。登場人物の一人「ドキュメントを書こうとするといつも頭が真っ白になる」が想定読者なので、章立ても説明も、段階を踏んで「こうしましょう」。（「こうもできる」「あれもできる」「こうしても良いね」はほぼ無い）という内容を求めている人にはオススメできる。

2024/12/03