“技術文書を書くこと”について考える(その2)

投稿日

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その1)へのリンク】 

1.技術文書を書く目的

技術文書を書く目的とは、技術文書の書き手からその読み手に内容を伝達することです。内容とは、書き手が読み手に伝えることです。例えば、仕事の成果、会議や打ち合わせで説明すること、提案や企画の内容、メールで伝えることなどです。書き手はこれらのことを読み手に伝達するため(伝えるため)に技術文書を書きます。

 

2.「内容が伝わる」と「内容が“明確に”伝わる」の違い

「内容が明確に伝わる技術文書」を書くことで技術文書を書く目的が達成できます。ここでは、「内容が伝わる」と「内容が“明確に”伝わる」の違いを解説します。以下の2つの文章を比べてください。

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

 

の文章が、「『内容が伝わる』文章」です。書き手がAを選んだこと、すなわち、内容は伝わります。しかし、Aを選んだ具体的な根拠が書いてありません。そのため、この文章を読んだ人は、「何でAを選んだのだろうか、自分だったらBを選ぶと思う。他の人もBあるいはCを選ぶと思う」とこの文章に疑問を持つかもしれません。これでは、読み手がAを選んだこと(内容)が明確に伝わりません。「内容が伝わる」とは、内容がぼんやりと伝わることです。

 

の文章が、「『内容が“明確に”伝わる』文章」です。書き手がAを選んだこととAを選んだ具体的な根拠が書いてあります。このような文章であれば、「なるほど、書き手がAを選んだ根拠がわかった。自分だったらBを選ぶと思う。しかし、書き手は自分と違った視点でAを選んだのか」と思いAを選んだこと(内容)が明確に伝わります。「内容が明確に伝わる」とは、内容がはっきりと伝わることです。

 

「内容が明確に伝わる技術文書」とは、「内容がはっきりと伝...

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その1)へのリンク】 

1.技術文書を書く目的

技術文書を書く目的とは、技術文書の書き手からその読み手に内容を伝達することです。内容とは、書き手が読み手に伝えることです。例えば、仕事の成果、会議や打ち合わせで説明すること、提案や企画の内容、メールで伝えることなどです。書き手はこれらのことを読み手に伝達するため(伝えるため)に技術文書を書きます。

 

2.「内容が伝わる」と「内容が“明確に”伝わる」の違い

「内容が明確に伝わる技術文書」を書くことで技術文書を書く目的が達成できます。ここでは、「内容が伝わる」と「内容が“明確に”伝わる」の違いを解説します。以下の2つの文章を比べてください。

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

 

の文章が、「『内容が伝わる』文章」です。書き手がAを選んだこと、すなわち、内容は伝わります。しかし、Aを選んだ具体的な根拠が書いてありません。そのため、この文章を読んだ人は、「何でAを選んだのだろうか、自分だったらBを選ぶと思う。他の人もBあるいはCを選ぶと思う」とこの文章に疑問を持つかもしれません。これでは、読み手がAを選んだこと(内容)が明確に伝わりません。「内容が伝わる」とは、内容がぼんやりと伝わることです。

 

の文章が、「『内容が“明確に”伝わる』文章」です。書き手がAを選んだこととAを選んだ具体的な根拠が書いてあります。このような文章であれば、「なるほど、書き手がAを選んだ根拠がわかった。自分だったらBを選ぶと思う。しかし、書き手は自分と違った視点でAを選んだのか」と思いAを選んだこと(内容)が明確に伝わります。「内容が明確に伝わる」とは、内容がはっきりと伝わることです。

 

「内容が明確に伝わる技術文書」とは、「内容がはっきりと伝わる技術文書」と言い換えることができます。

 

次回に続きます。

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
テーマをかたまりに分けて書く かたまりに分けて書く(その2)

 前回のその1に続いて解説します。   1. かたまりに分けて書く    2018年2月15日に掲載した記事のテーマは「かたま...

 前回のその1に続いて解説します。   1. かたまりに分けて書く    2018年2月15日に掲載した記事のテーマは「かたま...


読み手の立場に立って文書を書くとは

1. 読み手の立場に立って文書を書く  これまでに掲載した記事の中で以下のことを何度も書きました。    わかりやすい文書を書くうえで最も重要な...

1. 読み手の立場に立って文書を書く  これまでに掲載した記事の中で以下のことを何度も書きました。    わかりやすい文書を書くうえで最も重要な...


「ネガティブな内容が含まれる報告書、企画書、認可書類を一瞬で合意する」形容詞化戦略(上級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その7)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


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

もっと見る
人財教育・人材育成、どのような方法が最も効果的かを考えるより、とにかく行動を最優先にする

【目次】 1. 一生懸命 「一生懸命頑張ります」という言葉はよく言います。新しい目標などに対して決意表明のように使われます。とても...

【目次】 1. 一生懸命 「一生懸命頑張ります」という言葉はよく言います。新しい目標などに対して決意表明のように使われます。とても...


‐能力開発のシステム創り 製品・技術開発力強化策の事例(その44)

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

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


伝えることの難しさ

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...