内容が明確に伝わる技術文書の書き方(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
内容が明確に伝わる技術文書の書き方(その9)

  今回は、「内容が明確に伝わる技術文書の書き方の第2原則(内容が明確に伝わる構成を考える)」と「内容が明確に伝わる技術文書の書き方の第3...

  今回は、「内容が明確に伝わる技術文書の書き方の第2原則(内容が明確に伝わる構成を考える)」と「内容が明確に伝わる技術文書の書き方の第3...


人材育成・組織・マネジメントの考察 【連載記事紹介】 

    ◆人材育成・組織・マネジメントの考察 物事はシンプルに考えることで、問題解決の道が一気に開けてきます。情報を素早く流...

    ◆人材育成・組織・マネジメントの考察 物事はシンプルに考えることで、問題解決の道が一気に開けてきます。情報を素早く流...


問題解決が進まないチームには、同じような「クセ」がある

  問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...

  問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...


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

もっと見る
「相手中心」で喜ばれる会話と怒りをよぶ会話の具体例

  1. 押しつけは怒りを呼ぶ。だったら、相手に任せればいい?  「A案とB案を比べるとA案が有利なのは明らかですから、A案を採用すべき...

  1. 押しつけは怒りを呼ぶ。だったら、相手に任せればいい?  「A案とB案を比べるとA案が有利なのは明らかですから、A案を採用すべき...


【SDGs取組み事例】知識ゼロから出発。計400トンのCO<sub>2</sub>削減に成功 来ハトメ工業株式会社

2010(平成22)年にエコアクション21認証を取得し、ゼロの状態から脱炭素化に向けた取り組みを始めた来ハトメ工業株式会社(埼玉県八潮市)。電力使用量...

2010(平成22)年にエコアクション21認証を取得し、ゼロの状態から脱炭素化に向けた取り組みを始めた来ハトメ工業株式会社(埼玉県八潮市)。電力使用量...


人はタイミングよく誉めよ -3つの例を添えて-

 私はクリーン化指導で多くの現場に立ち会ってきましたが、どんな業種、職種でも、人財育成はその会社、企業にとっては非常に大切なことです。故に日本では、昔から...

 私はクリーン化指導で多くの現場に立ち会ってきましたが、どんな業種、職種でも、人財育成はその会社、企業にとっては非常に大切なことです。故に日本では、昔から...