kitoketa blog

AWS/GCP、プログラミング、育成、リーダー、本の感想、などについて

ロジカルライティングとテクニカルライティングの基礎知識

初めに

普段業務をしていて、些細な連絡から、障害報告など毎日何かしらの文章をみなさん書いているはずです。その文章って本当に読み手に完璧に伝わっていますか?うまく伝わってなかったことで無駄なコミュニケーションコストがかかったことが必ず一度はあると思います。文章力は一生役立つ基本的なスキルです。

私も最近業務で重要な報告を偉い人に書いたり、後輩に文章作成のサポートをする機会が増えてきたので、今一度「伝わりやすい文章」とは何かを学んでみました。

下記の本を参考にさせていただき、私なりに重要だと思うところをまとめました。

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

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

  • 作者:髙橋 慈子
  • 発売日: 2018/11/19
  • メディア: 単行本(ソフトカバー)
 

 

基礎知識

分かりやすい文章が書けるとどうなる?

f:id:kitoketa:20200428235014p:plain

分かりにくい文章とは?

  1. 一文が長く、情報量が多い

  2. 読み手を意識せず、自分視点で書いてある
  3. 基本的なライティング技術を活用していない

f:id:kitoketa:20200429104444p:plain 

ロジカルライティング

  • ロジカル=論理的

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

  • 「なぜ、よいのか」、「どうして、そうするのか」を論理的に説明できないと相手は動いてくれない

f:id:kitoketa:20200429104553p:plain

 

「読み手」を意識する
  • 書いた文章は誰が読むのかをまず意識する

  • 読み手は提出した担当者、上司だけではない
    ・誰が読むのか、目の前にいる読み手だけでなく、広げて考える意識付けをすると、文章の分かりやすさが改善する

f:id:kitoketa:20200429104942p:plain

 

「目的」を明確に設定し、読んだ人の行動を想定する

障害報告メールの例

  • 目的
    ・障害に対するお詫び
    ・原因、対処、今後の取り組みの報告

  • 読んだ人に期待する次の行動
    ・障害対応を適切にしたことを理解してもらう
    ・今後も安心してシステムを使ってもらう

会議の議事録の例

  • 目的
    ・会議で決定したことを共有する
    ・未決の事項を確認し、次の行動につなげる
  • 読んだ人に期待する次の行動
    ・決定事項を各担当者が業務で進める
    ・未決事項を決めるための関係者が準備する

「文書が仕事を動かしてく」

書き出す前にロジックを組み立てる
  • 読み手と目的を分析したら、いきなり書き始めるのではなく、盛り込むべき情報を収集し、文書のロジックを組み立てる

f:id:kitoketa:20200429105531p:plain

ロジックを組み立てるメリット
  • 全体像をイメージしやすくなる

  • 説明の順番が整理される

  • 情報が漏れなく、ダブりが生じなくなる

  • 文章を早く書ける

  • 読み手が理解しやすくなる

テクニカルライティング

技術的な情報を分かりやすく伝えるための文章技術

読み手を理解し、情報を整理して、適切な量を、適切な表現で伝える

f:id:kitoketa:20200429105655p:plain

テクニカルライティングのメリット
  • どんな人でも理解しやすい

  • 読み手が知りたい情報にアクセスしやすい

  • 不要な問い合わせがなくなる 

分かりやすく、簡潔な文章を書くテクニック

 一文一義で書く

  • 一つの分には、一つの主題に絞って書く
    ・ 「。」を区切りにする
    ・1つの主題を持った「分」がまとまって「文章」を構成する

文を長くしない。「~(だ)が」、「~ので」で分を繋げない

  • 「~(だ)が」、「~ので」が入った文章は最も伝えたいことが分の最後に来ている

一文を短く。50文字以内に収める

  • 50文字以内が理解しやすい情報量

  • 短い文にこそ、文章力が問われる

5W2Hを盛り込み、曖昧な文章にしない

 簡潔に書くことは、情報量を減らすという意味ではない。省いてはいけない情報が何かを意識し、しっかりと文章に盛り込みます

f:id:kitoketa:20200429110004p:plain

曖昧な文章

読み手の解釈

改善した文章

来週いっぱいまでにお願いします

来週の金曜日中?

来週の金曜日の定時まで?

来週3/27(金) 17:00 までにお願いします

レビューお願いします

とりあえず見ればよい?

レビュー指摘はメールすればよい?

目的はなに?

よりよいツールにしていくために、レビューお願いします。

レビューコメントは私までメールにて送信してください

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

BEFORE

AFTER

打ち合わせについて

次回、打ち合わせのひってい変更のお願い

ご相談

Webサイト更新作業のご相談

スケジュールの件

[要確認]〇〇プロジェクトのスケジュールと進捗

話し言葉」と「書き言葉」を使い分ける

 ビジネス文書では「書き言葉」が適している

話し言葉

書き言葉

~していて

~しており

~してなくて

~しておらず

全然

全く

もっと

さらに

どうして

なぜ

~けれど

~が

~とか

すみません

申し訳ありません

接続詞の使用は最小限に抑えて、効果的に使う

  • 接続詞の役割は、文と文の関係を明確にすること
    ・ただし、接続詞を使いすぎると冗長になる

  • 文のつながりが分かれば、接続詞は無くても伝わる

  • 連続した番号で示せば、接続詞はいらない

    f:id:kitoketa:20200429110254p:plain

種類

接続詞

順接

したがって

それで

よって

逆説

しかし

ところが

並立

また

および

添加

なお

そして

説明・補足

なぜなら

ただし

つまり

対比・選択

または

あるいは

転換

ところで

一方で

 

読み手に伝わる文章を書くテクニック

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

  • 読み手に伝えたいことがスピーディーに伝わる

f:id:kitoketa:20200429110344p:plain

否定表現に気を付ける

  • 二重否定にしない
    ・両方とも肯定形にする
    ・前半は否定形、後半を書き換える

f:id:kitoketa:20200429110501p:plain

受動態と能動態を使い分ける

  • 読み手がすべきことは能動態、結果は受動態で書く

f:id:kitoketa:20200429110553p:plain

具体的に情報を盛り込んで書く

  • 具体的な対応を盛り込まないと、読み手は納得しない

障害報告の例

報告内容

具体例

いつ起こったか

2020年3月21日 12:00~13:00

原因

投入したデータ500件中5件に、入力漏れがありました

今後の対応

2020年3月21日 17:00までに、5件の不正データを正しく再投入します

「など」を多用しない

  • 「など」を多用すると文章を曖昧にしてしまう

f:id:kitoketa:20200429110656p:plain

レビューを受けて、分かりやすさを高める

レビューチェックリスト

チェック

レビューの観点

 

タイトルから文章の目的が伝わる

 

全体の構成がロジカルに組み立てられている

 

ロジックが見出しからわかるように書かれている

 

文と文のつながりがある

 

必要な情報が盛り込まれている

 

不要な情報が書かれていない

 

一文が長すぎない。50文字以下を目安

 

話し言葉ではなく、書き言葉で書いている

 

敬語表現が適切に書かれている

 

表記の揺れがない

 

固有名詞が間違っていない

 

誤字、脱字がない

最後に

 わかりやすい文章を書くのに必要なのは、センスではなく、これらのテクニックを意識してたくさんの文章を書く努力です。

私もブログなどでアウトプットする際にこれらのテクニックを意識して少しずつ上達していきたいです。