Books

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

仲田尚央

Product Details

ISBN/Catalogue Number
ISBN 13 : 9784802614849
ISBN 10 : 4802614845
Format
Books
Publisher
Release Date
September/2024
Japan
Co-Writer, Translator, Featured Individuals/organizations
:

Content Description

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

目次 : 基礎編(良いドキュメントを効率良く書くために/ ドキュメントの読み方を理解する/ 読み手とテーマを選定する/ テーマを分解する/ ドキュメントの骨組みを組む/ 文章を書く/ わかりやすい文を書く/ ChatGPTで効率良く書く)/ 実践編(ドキュメントの構成例)

【著者紹介】
仲田尚央 : テクニカルライター、UXライター。主にソフトウェアのUIテキストやドキュメント(マニュアル、リリースノートやテクニカルドキュメントなど)を書くことを専門とする。また、それらのローカライズにも携わる。サイボウズでテクニカルライター、ローカライズ部門のマネージャーを務めたのち、2024年から現職であるSmartHRで活動中。本業の傍らで、企業や学生向けにテクニカルライティングのセミナーを実施。Developers Summit 2023アワード受賞。都立産業技術高等専門学校非常勤講師(本データはこの書籍が刊行された当時に掲載されていたものです)

(「BOOK」データベースより)

Customer Reviews

Comprehensive Evaluation

☆
☆
☆
☆
☆

0.0

★
★
★
★
★
 
0
★
★
★
★
☆
 
0
★
★
★
☆
☆
 
0
★
★
☆
☆
☆
 
0
★
☆
☆
☆
☆
 
0

Book Meter Reviews

こちらは読書メーターで書かれたレビューとなります。

powered by

  • ますみ

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

  • 安心院

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

  • 静岡茶

    新卒向け。ページを進むにつれて文章が冗長になる。なぜか? AI が作っている文章だからだろうか。

  • じゅん

    文書書くときに迷うことが多かったので読んでみた。ある程度参考にはなるが結局は上司や同僚のレビューを受けて場数を踏むしかないなと思った。特に組織に文書の手順書などがある場合はそれを読み込んだ方がいいと思う。

  • ゆうやけPC

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

レビューをもっと見る

(外部サイト)に移動します

Recommend Items