“技術文書を書くこと”について考える(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
説明力と説得力を高めるための戦略とは

  コミュニケーションについて学ぶことは、あなたの話し方の質を高めます。相手を「うん!わかった!」と思わせる話し方は、あなた自身と組織に強...

  コミュニケーションについて学ぶことは、あなたの話し方の質を高めます。相手を「うん!わかった!」と思わせる話し方は、あなた自身と組織に強...


報連相とは

     報連相(ほうれんそう)とは、職場で仕事を円滑に進めるために欠かすことが出来ない「報告」「連絡」「相談」のことです。 ...

     報連相(ほうれんそう)とは、職場で仕事を円滑に進めるために欠かすことが出来ない「報告」「連絡」「相談」のことです。 ...


【快年童子の豆鉄砲】(その113)OJCCとは(13)育成効果の活かし方

  1. 育成効果の活かし方 これまで、連載の12回を使ってOJCC(On the Job Cultivating Core-compe...

  1. 育成効果の活かし方 これまで、連載の12回を使ってOJCC(On the Job Cultivating Core-compe...


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

もっと見る
コストを明確にして、評価できる人材を育成する(その1)

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...


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

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

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


物流とスキル

1. 輸送のスキルとは  物流の仕事は専門性が強いものと思われます。何故なら多くの会社が物流業務をアウトソースしているからです。自社で簡単にできるの...

1. 輸送のスキルとは  物流の仕事は専門性が強いものと思われます。何故なら多くの会社が物流業務をアウトソースしているからです。自社で簡単にできるの...