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

エンジニアが一生困らないドキュメント作成の基本 [単行本] の 商品概要

• 要旨（「BOOK」データベースより）

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

• 目次

  ＜基礎編＞
  Chapter１　良いドキュメントを効率良く書くために
  Chapter２　ドキュメントの読み方を理解する
  Chapter３　読み手とテーマを選定する
  Chapter４　テーマを分解する
  Chapter５　ドキュメントの骨組みを組む
  Chapter６　文章を書く
  Chapter７　わかりやすい文を書く
  Chapter１～７までの振り返り
  Chapter８　ChatGPTで効率よく書く
  
  ＜実践編＞
  Chapter９　ドキュメントの構成例

• 出版社からのコメント

  ドキュメント嫌いのエンジニアにこそ読んでほしい！

• 内容紹介

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

• 著者紹介（「BOOK著者紹介情報」より）（本データはこの書籍が刊行された当時に掲載されていたものです）

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

• 著者について

  仲田 尚央 (ナカタ ナオヒロ)
  テクニカルライター、UXライター。主にソフトウェアのUIテキストやドキュメント（マニュアル、リリースノートやテクニカルドキュメントなど）を書くことを専門とする。また、それらのローカライズにも携わる。
  
  サイボウズでテクニカルライター、ローカライズ部門のマネージャーを務めたのち、SmartHRでUXライターとして活動する。本業の傍らで、企業や学生向けにテクニカルライティングのセミナーを実施。Developers Summit 2023 アワード受賞。都立産業技術高等専門学校 非常勤講師。

エンジニアが一生困らないドキュメント作成の基本 [単行本] の商品スペック