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

仲田尚央

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

定価: 2,420円（本体価格 2,200円）

発売日

2024年9月19日
判型／ページ数

A5判／304ページ（オール2C）
ISBN

978-4-8026-1484-9

この書籍を購入する

この書籍を問い合わせる

キーワード：: ドキュメントライティング / 要件定義書 / 設計書 / リリースノート / 仕様書 / マニュアル

概要
目次
正誤表・ダウンロード

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

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

＜実践編＞
Chapter９　ドキュメントの構成例

お問い合わせ

本書に関するお問い合わせは、下記のボタンをクリックしてお問い合わせフォームよりお問い合わせください。

この書籍を問い合わせる

概要
目次
正誤表・ダウンロード

author執筆者紹介

仲田尚央

テクニカルライター、UXライター。主にソフトウェアのUIテキストやドキュメント（マニュアル、リリースノートやテクニカルドキュメントなど）を書くことを専門とする。また、それらのローカライズにも携わる。サイボウズでテクニカルライター、ローカライズ部門のマネージャーを務めたのち、2024年から現職であるSmartHRで活動中。本業の傍らで、企業や学生向けにテクニカルライティングのセミナーを実施。Developers Summit 2023 アワード受賞。都立産業技術高等専門学校非常勤講師。著書に『ヘルプサイトの作り方』（技術評論社）がある。

Twitter: @naoh_nak