ドキュメントを書くハードルを下げてくれる本『エンジニアが一生困らないドキュメント作成の基本』
今週発売の新刊『エンジニアが一生困らない ドキュメント作成の基本』を御恵投いただきましたので、その感想です。
一般的な「文章術」との違い
世の中には「文章の書き方」についての本は多くあります。私もたくさんの本を書く中で、他の人の「文章の書き方」や「文章術」についての本を読んできました。
その多くは「伝わる文章」を書くための「テクニック」を取り上げた本です。どんなテクニックがあるのかを知りたい方は、以下のような本を読んでみるのもいいでしょう。
こういった本を読むと、文章を書くときのテクニックはよくわかります。
ある程度の文章が書ける人が、ビジネスの場面で読みやすい文章にするには、このような本が有効です。
しかし、今回の本『エンジニアが一生困らないドキュメント作成の基本』はそもそもの読者対象や目的が違います。
まず、読者対象をエンジニアに絞っています。特にITエンジニアが仕様書やマニュアル、作業手順書、論文、企画書などを作成するときに使える本が意識されています。
このような文書(ドキュメント)は、小説やブログのような文章を書くこととは違うことが想像できるでしょう。
そして、目的として「文章を読ませること」ではなく以下の3つが挙げられています。
概念や手順を説明する(説明型)
知見や活動を報告する(報告型)
意見や提案を伝え、相手の行動を促す(説得型)
つまり、「文書の書き方」と「文章の書き方」の違いだと考えると、一般的な「文章術」とは違う本であることがよくわかります。
ドキュメントの構成や作成の手順がわかる
上記のような目的を考えたとき、作られる文書(ドキュメント)にはある程度の「型」があります。この文書の「型」を理解することが、本書の帯にあるような「速く正確にわかりやすく」書くうえで重要です。
このため、本書ではドキュメント作成を「5つのステップ」に分けて解説されています。
目的:読み手とテーマを選定する
テーマ:テーマを分解する
見出し:ドキュメントの構成を組む
パラグラフ:文章の構成を組む
文:文を書く
そして、それぞれのステップに沿って進行していくため、「5」の「文を書く」というところに割かれているページ数は多くありません。
それよりも、「1」から「4」の割合が多くなっています。
この「1」から「4」、つまり文を書く前の準備がドキュメントの作成に重要である、というわけです。これを「段階を踏んで」作っていくことで、いきなり文章を書くハードルを下げていると言えます。
ChatGPTによる構成や校正に注目
最近は書店に行くと、「ChatGPT」をはじめとする生成AIの本が多数並んでいます。
本書でも、「ChatGPT」についての章が用意されており、よくある「プロンプト」の指示の出し方などについても解説されています。
それ以上に注目なのが、図8-4「ChatGPTで変わるドキュメント作成のプロセス」という図です。
通常のプロセスと、ChatGPTを活用したプロセスについて表現されており、なかなか面白い視点だと感じました。
まとめ
エンジニアというとプログラムを書く仕事などを思い浮かべる人も多いものですが、それよりも圧倒的に多いのが「さまざまな文書を作成する」時間です。
これまでに多くの文書を作成してきた方にとっても、うまく言語化されていて納得するところが多いでしょうし、文書の作成に悩んでいる方にとっては、効率よく進めるための考え方や文書の作り方を学べる1冊だと思います。
この記事が気に入ったらサポートをしてみませんか?