Shoeisha Technology Media

CodeZine(コードジン)

特集ページ一覧

実用文で「起承転結」はNG! 伝わりやすいテクニカルライティングを実践する4つのコツ

  • LINEで送る
  • このエントリーをはてなブックマークに追加
2018/11/27 07:00

 相手に伝えるための文章には工夫が必要です。特に領域を問わず技術に関することをわかりやすく伝えるのは簡単ではありません。では、技術文書を書くテクニカルライティングにはどんなコツがあるのでしょうか。翔泳社の『技術者のためのテクニカルライティング入門講座』から4つ紹介します。

本記事は『技術者のためのテクニカルライティング入門講座』から内容を抜粋し、掲載にあたって一部を編集したものです。

そもそも「論理的」とはどのようなことか

「論理的」とは、筋道が通っていること

 わかりやすく伝わり、読み手の次の行動につながる文章は、「論理的」に書かれています。「論理的」を一言で説明するなら、「筋道が通っていること」と言えます

 「道案内」を例に説明すると、筋道が通っている場合は目的地まで迷わないように進むべき道が示されています。筋道が通っていない場合は、あちこちに余分な説明があり、行きつ戻りつと遠回りして目的地まで進んでいきます。筋道が通った説明なら、迷うことなく次に進めますから、説明を受けた人は短時間で目的まで達することができるのです。

「論理的」な文章が求められる背景

 現在の仕事の場は、従来にも増して論理的な文章が求められるようになりました。その理由は、ビジネスの環境が大きく変わりつつあるからです。国内市場を中心に業界の中で競いあう時代は、とうに終わりました。ものづくりが大きく変わりつつある今、お客様にも、仕事の仲間にも、「これまでと同じような伝え方でいいだろう」、「説明しなくてもわかるだろう」では、通用しなくなっています。

 「なぜ、よいのか」、「どうして、そうするのか」を論理的に説明できなくては、相手は動いてくれません。まして文化が異なる海外拠点の関係者や業界が異なるビジネスパートナーと仕事を進めるには、論理的に文章で伝えるスキルが必須になります

「読み手の筋道」に整理し直して書くこと

 たとえ筋道が通った説明であっても、読み手は納得できない説明があります。これは、書き手の論理を押しつけている文章です。 たとえば新しい技術を説明するときに、いかに素晴らしい機能なのか、従来の技術では解決しなかったことをどのような手法で解決して機能に反映させているのかといったことを詳細に説明しても、読み手はピンとこないでしょう。読み手が知りたいのは、その機能によって自分たちのビジネスにとってどのようなメリットがあるのか、どのように課題が解決するのかであって、新しい技術の詳細ではないからです。

 したがって、説得できる文章にするには、頭の中にある書き手の論理を読み手視点の論理へと変換すればよいことになります

論理的でない文章=目的まで迷いながら進まなくてはならない
論理的な文章=目的まで迷わず進め、筋道が通っている

情報をわかりやすく伝えるための「テクニカルライティング」

テクニカルライティングのメリット

 「テクニカルライティング」とは、技術的な情報を利用者にわかりやすく伝えるための文章技術です

 技術的な情報は、量が多く、専門的な内容も含まれているので、一般的な利用者には難しくて理解しにくいものです。読み手を理解し、情報を整理して、適切な量を、適切な表現で伝えることが重要です。

 米国では1950 年代にテクニカルライティングが登場し、大学では専門のコースがあります。さまざまな新しい製品が生み出され、市場を広げていった時代に、利用者に正しい使い方を伝えるためには技術分野に合わせたライティング技術が重要だとして、テクニカルライティングは生まれました。

 わかりやすく使用方法を説明すれば、ユーザーからの問い合わせ対応のための人員や工数を削減できます。日本でも、専門コースはなくてもテクニカルコミュニケーションの業界団体や各種の研究コミュニティで、テクニカルライティング技術を研究し、情報交換し、活用しています。

 製品やサービスを安全に利用者に使ってもらうための製造物責任の観点からも、近年、製品の使用方法の説明の重要性が高まっています。正しく安全に使ってもらうための注意点が書かれていれば、利用者が間違った使い方をして怪我をしたり、事故を起こしたりするのを未然に防ぐことができます。万が一、事故があっても損害賠償のリスクを軽減するための検討材料になります。

理解し、適切に使うためのライティング技術をビジネスにいかす

 「テクニカルライティング」を活用している典型的な例は、ユーザーマニュアルや取扱説明書です。これらには利用者が製品の機能を理解して、間違えず適切に使うための説明が盛り込まれています。

 利用者が理解しやすく迷わないように、次の図のように情報の種類を分けて整理して書くのも、テクニカルライティングの基本セオリーです。

 図はユーザーマニュアルの典型的なフォーマットです。ユーザーの作業ごとに、それはどのような機能なのか、どう操作するのか、知っておくと便利な補足的なことは何かを、要素ごとに分けて書きます。とにかく操作方法を知りたい人は手順を読み、機能からじっくり知りたい人は機能概要から読むというように、知りたい情報にアクセスしやすいよう、情報整理をしています。

 その他にも認知心理学からの知見を取り入れるなど、人の理解に合わせた文章の書き方が、テクニカルライティング技術に応用されています。

ユーザーマニュアルの構成と要素

メールの件名、文書のタイトルから目的が伝わるように書く

何のためのメールや文書なのか、最初に伝える

 仕事をスピードアップする、わかりやすい文書への改善策として高い効果を見込めるのが、メールの件名、文書のタイトルから目的が伝わるように書くということです。メールの件名や文書のタイトルは読み手が最初に目にする情報ですから、目的がズバリと伝わるように書きましょう。

 たとえば、メールの件名に「打ち合わせについて」とだけ書いてある場合を考えてみます。これでは、打ち合わせの日時や場所の連絡なのか、あるいは日程を変更して欲しいとの要望なのか、内容に関する準備についてや確認なのか、本文を読まないとこうした情報はわかりません。

 曖昧な表現では、読み手にはメールの目的が伝わりません。もしも「ご相談」だけならば、「何の相談なのか書いてあればいいのに……」と読み手は思うことでしょう。

 「打ち合わせについて」ではなく、「次回、打ち合わせ日程変更のお願い」のように目的がわかりやすいよう、具体的なキーワードを入れて書きましょう。

 曖昧なメールの件名や文書のタイトルによく使われているのが、「~について」や「~の件」といった表現です。これらの表現は間違いではありません。しかし、その先の「~について」何を伝えたいのかが抜けているので、目的が伝わりにくいのです。

目的をカッコ書きにしてメールの件名の冒頭に書く

 また、社内メールならば、[要返信]、[依頼]といった目的を、カッコ書きにしてメールの件名の冒頭に書いてもよいでしょう。最初に目にする語句で目的が伝わります。社外メールの場合は状況と相手によりますが、「~のお願い」「ご確認ください」といった表現にするとよいでしょう。

内容や目的の記載がないメールの件名例と、記載した改善例

検索性を高めることも意識しよう

 議事録や報告書などを文書としてまとめるときには、タイトルにキーワードを盛り込んでおくと、後から資料を探しやすくなります

 たとえば、他の資料と一緒に提出するときには、タイトルが「関連資料」だけでも内容が推測できます。しかし、関連する元の文書と別々になっていたら、何の関連資料なのかはわかりません。後から資料を探すときに、苦労することになります。

 そこで、『「△△イベント」 関連資料』とより具体的にタイトルに書いておけば、タイトルを見ただけで資料の内容がわかります。すぐに目的の資料を見つけることができますから、検索性も高まります。

 「議事録」の場合は、何の会議の議事録なのかを書きましょう。複数回続いている会議ならば回数を記載しておけば、会議の開催順に内容を確認するのに便利です。

 研修の受講報告ならば研修名を盛り込み、「受講報告」のキーワードを盛り込んでおけば、一目瞭然です。これまでどのような研修を受講・実施したのかをまとめるときにも、役に立つことでしょう。

タイトルは、後日、その文書を再利用することを考えてつけよう
内容や目的がわからない文書のタイトル例と、改善例

最も重要な内容を先に書く

重要なことを最後に書く、「起承転結」は実用文ではNG

 物語で使われる文章の構成「起承転結」は、「結」が最後に来る組み立てです。関心を引きつける冒頭の「起」の部分から「結」まで、順番に進めていきます。最後まで読むことで、言いたいことが伝わるような文章です。

 技術文書や各種の報告書、メール文などの実用文では、最後まで読まないと伝えたいことがわからない書き方は不向きです。忙しい読み手に負担をかけることになります。そこで、最も重要な内容、目的を最初に書く組み立てにします。読み手に伝えたいことがスピーディーに伝わるからです。

 お互いに忙しい仕事の現場では、「最後まで読まないとわからない」という書き方は、歓迎されません。それどころか、忙しい上司はイラッとして、「伝えたいことは、先に書け」と小言を言うかもしれません。

質問の回答は最初に解決方法を伝える

 実際に重要な内容を最後に書いている例と、最初に書いている例で比べてみましょう。ユーザーから「過去のログはどこに保存されているのか」と質問されたときの答えの一部を想定しています。

BEFORE 知りたいことに答える内容が最後に書いてある例

ご質問いただいた内容についてお答えいたしますが、操作方法がわからない場合や、必要なファイルが見つからない場合は、ご連絡ください。過去のログについては、年度ごとにフォルダーに階層を作り、その下に月ごとに管理されたフォルダーを作成して、ファイルを保存する方法で管理されております。たとえば、過去のログは、「20XX」のように年度フォルダーの下に、各月のフォルダーがあります。それらのフォルダーは、「past―record」フォルダーからアクセスしていただけます

AFTER 知りたいことに答える内容を最初に書いた改善例

過去のログを確認するには、「past―record」フォルダーにアクセスし、月ごとに管理されたフォルダーを開いてください。過去のログは「20XX」のような年度フォルダーの下に月ごとに管理されています。その中から目的のフォルダーを開いてください。操作方法がわからない場合や、必要なファイルが見つからない場合は、ご連絡ください。

 BEFOREの文章では、質問の内容をまとめ、それに続いてフォルダー構成の説明をし、最後に過去のログが「past―record」フォルダーに入っていることが書かれています。質問した人が知りたいことが、最後に置かれているため、全部を読まなくてはならない構成になっています。

 AFTERの文章では、過去のログを見るために探すべき場所を、最初の文で伝えています。読み手が知りたいことが最初に書いてあるので、疑問の解決にスピーディーにつながります。なくても伝わる冗長な表現を省き、必要な情報を読み取りやすくします。

「起承転結」は実用文ではNG
技術者のためのテクニカルライティング入門講座

Amazon SEshop その他


技術者のためのテクニカルライティング入門講座

著者:高橋慈子
発売日:2018年11月19日(月)
価格:2,376円(税込)

本書について

本書では、忙しい技術者の方でも「テクニカルライティング」を通じて、相手に伝わる技術文書を効率よく 書けるようになるテクニックを多数紹介していきます。

 



  • LINEで送る
  • このエントリーをはてなブックマークに追加

著者プロフィール

  • 渡部 拓也(ワタナベ タクヤ)

     翔泳社マーケティング広報課。MarkeZine、CodeZine、EnterpriseZine、Biz/Zine、ほかにて翔泳社の本の紹介記事や著者インタビュー、たまにそれ以外も執筆しています。 Twitter@tiktakbeam

バックナンバー

連載:翔泳社 新刊紹介

もっと読む

All contents copyright © 2005-2018 Shoeisha Co., Ltd. All rights reserved. ver.1.5