文章どころか仕事全体の質も上がる『エンジニアが一生困らない ドキュメント作成の基本』
こんにちは、ミノ駆動です。
2024/09/19発売予定の書籍『エンジニアが一生困らない ドキュメント作成の基本』を、著者の仲田尚央氏よりご恵贈賜りました。
大変素晴らしい内容で、多くの方にオススメできるので感想を書きます。
誰にとってオススメか
本書はタイトルに「エンジニア」とありますが、エンジニアに限定せず以下の方すべてにオススメできると私は考えます。
ドキュメントを上手く書けなくて困ってる人
仕事で空回りしている感じがして、成果が上がらず困ってる人
本書の特徴 －目的達成のための文章－
本書冒頭より引用です。
ドキュメントは必要に迫られて読み書きするものです。すなわち、ドキュメントを読み書きすることには「目的」があります。
ドキュメントを読み書きすることは、何らかの目的を達成するための手段です。
ユーザーマニュアルは「利用者が機能を理解し使えるようになるため」、企画書は「アイデア実現にあたり利害関係者から承認を得るため」……といったように、ドキュメントにはそれぞれ目的があります。
目的を理解せずにドキュメントを書くとどうなるでしょうか。
たとえば酷い例では次のようなものがあるでしょう。
業務報告書が「今日は◯◯した」といった、稚拙な日記帳のような内容
履歴書の自己PR欄が自分の趣味や性格の羅列
業務報告書は、成果や問題点を共有しその後の改善に用いるものなので、目標と実績との差異、実績獲得に至るまでの背景などを盛り込む必要があります。
また、履歴書の自己PR欄は、企業ニーズに貢献するかどうかの判断に用いるものなので、貢献可能な部分に着目し、自己の強みや背景となるエピソードを盛り込む必要があります。
このように、達成したい目的に応じて書くべき内容が決まります。
ドキュメントライティングや読みやすい文章の書き方についてのノウハウ本は世の中にいろいろありますが、本書は始めから終わりまで一貫して目的を中心に解説しています。目的を定義し、目的達成のためにどのように文章を設計していくか。これが本書のユニークな特徴だと感じました。
目的達成のための文章構造を設計する
目的、目標、手段は以下の関係であることが知られています。
目的：目指すべき状態
目標：目的達成に必要なこと、何をもって達成したかを示す条件
手段：目標の条件を満たすための具体的な手段や行動
この三者を的確に設定することで、業務の成果や質が向上すると言われています。
全体的な所感として、本書はこの目的、目標、手段の関係性を踏まえた内容になっていると読めます。本書では、ドキュメントのテーマを以下の3つに分解することの重要性について説いています。
なぜ（why）
何を（what）
どうやって（how）
まさに目的、目標、手段の関係性そのものですね。
伝えたい内容を「なぜ、何を、どうやって」の観点で分解整理し、全体のアウトラインや文章構造を設計するノウハウについて分かりやすく解説しています。
この「設計」っていうのが良いですね。
本書内では「ドキュメント設計」という言い回しがされています。問題解決や効果促進を狙って意図的に文章構造を設計する。
文章の執筆は、才能のある一部の人だけが独占的に所有する能力だと思われている方が、もしかしたらいるかもしれません。私も昔そう思っていました。
しかし本書を読めば、要点をおさえて訓練することで、誰でもドキュメント設計スキルを向上できることが分かると思います。
読み手を意識した目的設定
折角ドキュメントを執筆しても、読み手に伝わらなければ目的を達成できません。
たとえば技術記事の中には、よく読むと折角良いことが書いてあるのに、何を意図した内容なのか読解が困難なものや、読み手のレベルがあまり考慮されていないと感じる、「もったいない」ものがあります。
内容が上手く伝わらないとき、想定読者についての理解が不十分であることが考えられます。
本書では、読み手に確実に内容伝達できるよう、読み手のレベルや立場にしっかり目線合わせした上で、ドキュメントの目的設定することの重要さを手厚く解説しています。
目的ベースの言語化は広く仕事の質を向上させる
これは書籍の内容ではなく完全に私の所感なのですが、この本は広く仕事の質の向上にも貢献するものだと感じました。
仕事で良い成果を出せないとき、目的に問題があるケースがあります。
会社にはさまざまな部門や業種がありますが、それぞれ違いはあれど、事業利益に貢献することが上位目的として存在します。
ここで、部門や個人が設定した目的が的外れだと、事業利益に貢献しない、ちぐはくな仕事になってしまいます。
一生懸命仕事をしているはずなのに、なぜか空回りして、良い成果を出そうにも出せない……。こうした悩みを抱えている方は少なくないはずです。
言われた通りに仕事をしているだけでそもそも目的を理解していないケースや、部下に与えた指示が目的と外れているケースなど、目的設定に問題が生じるケースはさまざまです。
目的をロストした状態ではチームの目線も揃いませんから、意見の食い違いなどトラブルが生じ、心理的安全性の向上も難しくなるでしょう。
このようなときこそ目的を整理し直す必要があります。
書籍『BIG THINGS どデカいことを成し遂げたヤツらはなにをしたのか？』でも、大きな成果を上げるには「なぜそれをするのか」目的をしっかり固め、目的に立脚したアイデアを熟考することの重要性を説いています。
しかし的確な目的の設定は、一朝一夕にできるものではありません。
目的の設定には、背景や解決したい課題、利害関係者や関係する要素など、多くの事柄を俯瞰して整理する必要があります。
人が脳内で考えていることは意外にぼんやりしているもので、頭の中で考えただけでは的確な目的設定は困難です。
だからこそ言語化が必要です。
言語化することで、物事の関係性や、分かっていることと分かっていないことの違いが明瞭になります。また、矛盾や誤りにも気付きやすくなります。
もちろん言語化そのものが高度な知的判断を要するものですから、独学では困難が伴うでしょう。
ここで、本書『エンジニアが一生困らない ドキュメント作成の基本』が役に立つと私は考えます。
本書には、目的をどう定義するか、目的達成のために何を言語化するのか、といったノウハウが網羅されています。
本書に基づいて文章設計することそのものが、目的を的確に言語化し、仕事の質を向上させることに繋がると、私は考えます。
仕事が上手くいっていない人ほど本書を読んで文章を設計し、実務に活かすことをオススメします。
もっと以前から知りたい内容だった…（遠い目
私には、伝えたいことがなかなか相手に伝わらず、悩んでいた時期がありました。下記はそのインタビュー記事です。
この時期は自分としても本当に堪えました。
インタビュー内容にはありませんが、この時期、ドキュメントライティングや人に上手く伝えるための方法について、いろんな本を読んで試していたのです。しかしどれも上手くいきませんでした。
ですが、記事にあるように目的を意識し始めてからだんだんと上手く伝えられるようになってきました。
相手の立場に合わせる、という考え方も、本書『エンジニアが一生困らない ドキュメント作成の基本』のノウハウと一致します。
もっと早く知っていたら、こんな苦しむこともなかったのかなと思います。
この「目的に立脚して伝達内容を整理する考え方」は、私はこれまで自分の経験と試行錯誤だけでやっていましたが、本書『エンジニアが一生困らない ドキュメント作成の基本』には、そのノウハウが体系的にまとめられているので、今後はより意識して文章設計をコントロールできそうな感触があります。
私は現在書籍を2冊執筆しています。
本書の知見を早速活用して、皆さんにとってより手に取りやすい内容に仕上げたいと思います。
また、これから本を書こうとしている人を何人か知っています。その人たちにも本書はぜひ読んでほしいと思います。
本書の活用どころ
本書にも書かれていますが、本を読んだだけではスキルは向上しません。
実際に訓練とフィードバックを繰り返すことで初めてスキルアップがのぞめます。
これは文章設計に限らず、どんなスキルに関しても言えます。
「量は質を凌駕する」という言葉がありますが、要点をおさえない「量」ほどムダなものはありません。
効率が悪い上に逆に形が悪くなったり、悪いクセが染み付いてしまってクセが取れなくなってしまうケースがあります。
私の生業はシステム設計です。他のメンバーに設計方法をレクチャーするのも業務の一部です。
指導の際、要点をおさえて、手を抜かず丁寧にモジュールを設計しきるように伝えています。こうしてひとつやふたつでもしっかり作り込むことで、多くの方が短期間で設計スキルが向上します。
文章設計も同様に、まずはこの本に書いてある要点を意識して、しっかり1本文章を書ききることが、スキルアップする上で大事なポイントではないかと私は考えます。
文章を書いたら、本書の要点と照らし合わせて点検するのも良いでしょう。
おわりに
ドキュメント作成は意思伝達スキルの一部であり、仕事の基本です。
本書『エンジニアが一生困らない ドキュメント作成の基本』は、タイトルにあるように、まさに一生もののスキル獲得に寄与する本だと思います。