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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
リスキリングを促進する姿勢とは、Why思考で人財育成 ~「自ら考える人財」を育てる

  先日、電車でシートに座りながら、解説書を読んでいる方がいました。本当はいけないのでしょうが、解説書を広げて読まれていたので、自然とタイ...

  先日、電車でシートに座りながら、解説書を読んでいる方がいました。本当はいけないのでしょうが、解説書を広げて読まれていたので、自然とタイ...


「伝える力と書く力」のレベルアップとその方法とは

【目次】 「技術者に必要な3つの力(その2)伝える力と書く力のレベルアップ注1)」で次のことを書きました。技術者は自分の専門分野の技...

【目次】 「技術者に必要な3つの力(その2)伝える力と書く力のレベルアップ注1)」で次のことを書きました。技術者は自分の専門分野の技...


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

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!     今回は、「書き方8...

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!     今回は、「書き方8...


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

もっと見る
目標達成の決定打、頭のキャパの空きスペースを作るには

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,00...

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,00...


コンプライアンス意識を持とう:職場のマネジメント

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...


【SDGs取組み事例】「働く喜びを」障がい者雇用続けて半世紀  日本理化学工業株式会社(神奈川県川崎市)

神奈川県川崎市で文具や事務用品の製造・販売などを行う日本理化学工業株式会社(代表取締役社長 大山 隆久氏)では、廃棄されるホタテ貝殻(かいがら)の粉末...

神奈川県川崎市で文具や事務用品の製造・販売などを行う日本理化学工業株式会社(代表取締役社長 大山 隆久氏)では、廃棄されるホタテ貝殻(かいがら)の粉末...