このページの本文へ

ここから本文

  1. Home
  2. ITトピックス
  3. 生産性が向上し読み手にしっかり伝わるテクニカルライティング入門講座

生産性が向上し読み手にしっかり伝わるテクニカルライティング入門講座

2019年4月 | SPECIAL FOCUS

報告書、打ち合わせ資料、提案書、議事録、マニュアルなど、業務の中で技術文書を作成する機会は数多くあります。分かりやすい文章を素早く書くことができれば、生産性が高まるだけでなく、事故の発生を防げるなどのメリットがあります。しかし、どうしたら文章力を向上させられるのか分からないという悩みを持つ方も少なくありません。今回は、誰にでも役立つテクニカルライティングの基本について解説します。

個人にも組織にもメリットが多い文章作成スキルの向上

チームの一員として働くことが一般的になった現代社会では、仕事内容を正確に記録に残したり、自分の考えをスムーズに他の人と共有することが求められます。口頭で伝えただけでは確実に共有したことにはなりません。ビジネスを円滑に進めるためには、文字で伝え、文字で記録することが不可欠です。

技術文書には、各種の報告書、打ち合わせ資料、提案書、議事録、マニュアルなどがあります。また、設計情報やプログラム内に書かれるコメントも重要な文章の一つです。ITの普及によって日常的なコミュニケーションも文章で行われることが多くなりました。文章作成のスキルは今後ますます重要になっていくでしょう。

分かりやすい文章を素早く書けるようになることは、生産性の向上につながります。技術者としての能力は高いのに文章を書くのが苦手なために、業務がスムーズに回らないという話はよく聞きます。一つの報告書で情報が正確に伝われば、問い合わせや手戻りがなくなり、個人だけでなく組織としての生産性も向上します。また、報告書などの内容は、人事評価を行う材料の一つになります。実力を正しくきちんと評価されるためにも、文章作成の能力は大切です。

文章を書くには何か特別な才能やセンスが必要だと思われがちです。また、技術系の人には、文章を書くことに苦手意識を持つ人が少なくありません。確かに、読む人を感動させるような文章を書くためには、ある種のセンスが必要かもしれません。しかし技術系に限らず、ビジネスで書く文章に求められるのは“情報を素早く正確に伝えること"です。より具体的には、分かりやすく簡潔な文章を書くことです。こうした実用的な文章を書く技術は、必要な知識を学びトレーニングを行うことで誰でも身につけることができます。

ロジカルライティングとテクニカルライティングの技術を活用

分かりやすい文章を書くために役立つ技術として、「ロジカルライティング」と「テクニカルライティング」があります。

ロジカルライティングは、文字通り論理的な文章を書くための技術です。論理的な文章とは、筋道がきちんと通っていて、読んだ人が短時間で目的を達成できるような文章です。道案内や手順書を思い浮かべると分かりやすいでしょう。情報の過不足や説明の順番が不適切だと、読み手はスムーズに目的を達成することができません。テクニカルライティングは、技術的な内容を目的や読み手に合わせて分かりやすく伝える手法です。広義のテクニカルライティングは、ロジカルライティングを含むこともあります。

論理的な文章を書くためには事前の準備が大切です。まずは、書き始める前に次の手順を踏むと良いでしょう。

1.作成する文書の目的と読み手を明確にする
2.書くべき情報を収集する
3.文章のロジックを組み立てる

文書の目的と読み手を明確にすることは最も重要です。マニュアルの目的はユーザーに製品やサービスの使い方を理解してもらうことですし、障害報告書であれば、お詫びと原因・対策の報告になります。さらに読み手が社内の人なのか社外の人なのか、どのようなポジションの人かによって書くべき内容や表現は変わってきます。

一見、当たり前のことのようですが、目的と読み手をしっかり意識しなければ、相手が知りたい情報ではなく、自分の伝えたいことだけを書いてしまいがちです。業務経験が豊富ではない新人が、文書の目的や読み手を十分に把握するのは難しいですから、最初は上司や先輩社員のサポートが必要になるでしょう。

ロジックツリーを使って集めた情報を整理する

目的と読み手が明確になれば、文書に盛り込むべき情報を収集し、ロジックを組み立てる作業に入ります。ロジックを組み立てる際に役立つツールとして、「ロジックツリー」があります。

ロジックツリーは、集めた情報を階層のあるツリー構造に整理することで、文章の全体像をイメージしやすくします。例えば図1のように,ツリーの枝が上から下に向かって広がるとともに内容を具体的にしていきます(図1)。3階層のロジックツリーでは、一番上には文書の目的(主題)が入り、第2階層には、盛り込む重要なポイントをいくつかに絞って書き込みます。第3階層には、それぞれのポイントを支える具体的な事実を書きます。これは文書の目次作成と似た作業ですが、ツリー上に視覚化することで全体がイメージしやすく、情報の整理がしやすくなります。

「一文一義」と「接続詞は最小限」を心がける

テクニカルライティングの技法は、文書表現、用字用語の使い分け、構成の仕方や見出しの付け方、レイアウトなど幅広い分野に及びます。まずはごくシンプルな原則から覚えていきましょう。

最初に身につけたいことが「一文一義」の原則です。これは、一つの文は一つの内容に絞って書くという意味です。一文に複数の内容を盛り込むと、ロジックが複雑化して読み手が内容を誤解する可能性が高くなります。一文一義に絞ることで、すっきりした分かりやすい文章になります。図2の文章を見ていただければ、その違いが分かるでしょう。一文一義の短い文章には、後からの修正や追加をしやすいというメリットもあります。

もう一つの原則としては、「接続詞の使用を最小限に抑える」ことがあります。事前にロジックを組み立てて、文と文のつながりがきちんとしている文章であれば、ほとんど接続詞は必要ありません。使わなくても意味が通じる文章では、接続詞は不要です。また、「しかし」のような逆接の接続詞を繰り返し使っている場合には、文章の流れそのものを再検討してみましょう。

“一文一義"と“接続詞を最小限にする"、この二つの原則を守るだけでも文章の分かりやすさが大きく向上するはずです。最後にもう一つ、書き上げた後には必ず読み返しをする習慣をつけましょう。

図1:ロジックツリーを組み立てる

図1:ロジックツリーを組み立てる

出典:髙橋慈子『技術者のためのテクニカルライティング入門講座』, 翔泳社 ,2018,p25

図2:一文一義を心がける

図2:一文一義を心がける

出典:髙橋慈子『技術者のためのテクニカルライティング入門講座』, 翔泳社 ,2018,p39

  • 本記事は、株式会社ハーティネスの髙橋慈子氏への取材に基づいて構成しています。
株式会社ハーティネス 代表取締役<br>髙橋 慈子 氏

株式会社ハーティネス
代表取締役
髙橋 慈子 氏

東京農工大大学卒。技術系出版社を経て、テクニカルライターとしてフリーランスで取扱説明書の作成に関わる。1988年テクニカルコミュニケーションの専門会社として、株式会社ハーティネス設立。同代表取締役。
企業の取扱説明書やマニュアル制作のコンサルティングや人材育成に関わる。大妻女子大学、立教大学、慶應義塾大学非常勤講師。情報処理学会ドキュメントコミュニケーション研究会幹事。著書に『技術者のためのテクニカルライティング入門講座』(翔泳社)、『人より評価される文章術』(共著・宣伝会議)など。

株式会社ハーティネス