内容が明確に伝わる技術文書の書き方(その3)

投稿日

技術文書

 

【この連載の前回:内容が明確に伝わる技術文書の書き方(その2)へのリンク】 

1.書き方の第1原則について

 

技術文書

 

「内容が明確に伝わる技術文書の書き方の第1原則:書き手と読み手の違いを認識する」は、内容が明確に伝わる技術文書を書くうえで最も重要な原則です。第1原則を理解するうえでのポイントは、書き手とは“知っている人”、読み手とは“知らない人”を認識することです。

 

2.読み手の立場に立って技術文書を書く

書き方の第1原則の考え方である「書き手とは“知っている人”、読み手とは“知らない人”を認識して技術文書を書くこと」とは、「読み手のことを考えて技術文書を書くこと」です。つまり、「読み手の立場に立って技術文書を書くこと」です。これは、「自分が知らない人の立場に立ち、知らない人の立場で読むことを考えて技術文書を書くこと」と言い換えることができます。

 

以下の文章を読んでください(“技術文書を書くこと”について考える(その2)参照)。

 

  • 「製品Aと製品Bと製品Cの比較の結果、製品Aを選んだ。3つの中で製品Aが最もよかったからだ。」

 

書き手の立場で書くとこのような文章を書くかもしれません。書き手は、製品Aを選んだ具体的な根拠を知っているので製品Aを選んだ根拠を書かなくてもこの文章が明確に伝わるからです。自分が知らない人の立場に立ち、知らない人の立場で読むことを考えて技術文書を書くと以下のような文章を書きます。

 

  • 「製品Aと製品Bと製品Cの比較の結果、製品Aを選んだ。3つの中で、製品Aは形がシンプルで色も美しくかつ最も使いやすかったからだ。」

 

自分が知らない人の立場に立ち、知らない人の立場で読むことを考えると、「読み手は知らない人だから、製品Aを選んだ具体的な根拠を書かないとAを選んだことが明確に伝わらない」と気が付くからです。

 

3.読み手を限定する

「内容が明確に伝わる技術文書の書き方」の解説では読み手を限定します。内容に関する専門分野の知識を持っている人を読み手とします。読み手を限定することで技術文書に書くことが絞り込めるからです。例えば、「この報告書を読む人は、電気自動車に関する専門分野の知識を持っているから、電気自動車の基本的な事項を今回の報告書の中で書かなくてもよいだろう」のような判断ができます。つまり、報告書に書くことが絞り込めます。読み手が内容を理解するうえで必要なことだけを書くことも内容が明確に伝わ...

技術文書

 

【この連載の前回:内容が明確に伝わる技術文書の書き方(その2)へのリンク】 

1.書き方の第1原則について

 

技術文書

 

「内容が明確に伝わる技術文書の書き方の第1原則:書き手と読み手の違いを認識する」は、内容が明確に伝わる技術文書を書くうえで最も重要な原則です。第1原則を理解するうえでのポイントは、書き手とは“知っている人”、読み手とは“知らない人”を認識することです。

 

2.読み手の立場に立って技術文書を書く

書き方の第1原則の考え方である「書き手とは“知っている人”、読み手とは“知らない人”を認識して技術文書を書くこと」とは、「読み手のことを考えて技術文書を書くこと」です。つまり、「読み手の立場に立って技術文書を書くこと」です。これは、「自分が知らない人の立場に立ち、知らない人の立場で読むことを考えて技術文書を書くこと」と言い換えることができます。

 

以下の文章を読んでください(“技術文書を書くこと”について考える(その2)参照)。

 

  • 「製品Aと製品Bと製品Cの比較の結果、製品Aを選んだ。3つの中で製品Aが最もよかったからだ。」

 

書き手の立場で書くとこのような文章を書くかもしれません。書き手は、製品Aを選んだ具体的な根拠を知っているので製品Aを選んだ根拠を書かなくてもこの文章が明確に伝わるからです。自分が知らない人の立場に立ち、知らない人の立場で読むことを考えて技術文書を書くと以下のような文章を書きます。

 

  • 「製品Aと製品Bと製品Cの比較の結果、製品Aを選んだ。3つの中で、製品Aは形がシンプルで色も美しくかつ最も使いやすかったからだ。」

 

自分が知らない人の立場に立ち、知らない人の立場で読むことを考えると、「読み手は知らない人だから、製品Aを選んだ具体的な根拠を書かないとAを選んだことが明確に伝わらない」と気が付くからです。

 

3.読み手を限定する

「内容が明確に伝わる技術文書の書き方」の解説では読み手を限定します。内容に関する専門分野の知識を持っている人を読み手とします。読み手を限定することで技術文書に書くことが絞り込めるからです。例えば、「この報告書を読む人は、電気自動車に関する専門分野の知識を持っているから、電気自動車の基本的な事項を今回の報告書の中で書かなくてもよいだろう」のような判断ができます。つまり、報告書に書くことが絞り込めます。読み手が内容を理解するうえで必要なことだけを書くことも内容が明確に伝わる技術文書を書くうえで重要なことです。

 

次回に続きます。

 

【参考文献】

森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日

 

関連解説記事「書くべきことを自分の頭の中ではっきりさせる」 

 

   続きを読むには・・・


この記事の著者

森谷 仁

「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!

「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!


「人財教育・育成」の他のキーワード解説記事

もっと見る
動機付けでチームの安全意識を高めるには

  私たちの行動は、モチベーションの高さで決まります。モチベーションが高ければ、意識も高まり、その行動の『質』が高まると同時にパフォーマン...

  私たちの行動は、モチベーションの高さで決まります。モチベーションが高ければ、意識も高まり、その行動の『質』が高まると同時にパフォーマン...


ライフキャリアの視点 技術者のキャリア整理法(その2)

 前回、技術者のキャリア整理法 (その1)自分自身のマーケティングについて述べました。今回は、(その2)ライフキャリアの視点です。人生には、楽しいこと、悲...

 前回、技術者のキャリア整理法 (その1)自分自身のマーケティングについて述べました。今回は、(その2)ライフキャリアの視点です。人生には、楽しいこと、悲...


情報の関係性を意識した話し方とは、学習効果を最大化する伝え方 

【目次】 1. 学習効果を最大化する伝え方 とにかくつまらない。 話がダラダラ続く。 テキストに書いてあることを読み続ける...

【目次】 1. 学習効果を最大化する伝え方 とにかくつまらない。 話がダラダラ続く。 テキストに書いてあることを読み続ける...


「人財教育・育成」の活用事例

もっと見る
‐能力開発のシステム創り 製品・技術開発力強化策の事例(その43)

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その42に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確...

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その42に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確...


人財教育・人材育成、解決すべき問題と避けるべき問題とは

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...


人財教育・人材育成、自分自身の感覚を研ぎ澄まして雰囲気言葉に要注意

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...