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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
OJTでは、教える側に対する教育が大切 効果的な教育研修の進め方(その2)

 OJT(On the Job Training)とは、仕事を通じて社員の能力開発を図るものですから、人材育成の中で、最も大切であり効果をあげやすいもので...

 OJT(On the Job Training)とは、仕事を通じて社員の能力開発を図るものですから、人材育成の中で、最も大切であり効果をあげやすいもので...


自分の仕事に余裕を作るには

1. 「捨てる」スキル   ◆商品開発に「捨てる」はもう常識    今回は、日々の仕事と商品仕様における「捨てる」スキルについ...

1. 「捨てる」スキル   ◆商品開発に「捨てる」はもう常識    今回は、日々の仕事と商品仕様における「捨てる」スキルについ...


革新的テーマを継続的に創出するための表彰をより良く機能させるためのポイント

 革新的テーマを創出するための環境には「ハードの仕組み」に加え、心理的な「ソフトの仕組み」が必要の訳ですが、今回はこの中から、表彰に焦点を当て議論をしたい...

 革新的テーマを創出するための環境には「ハードの仕組み」に加え、心理的な「ソフトの仕組み」が必要の訳ですが、今回はこの中から、表彰に焦点を当て議論をしたい...


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

もっと見る
【SDGs取り組み事例】インクルージョンされた職場環境において、新しい価値を生み出し続ける ソニー・太陽株式会社(大分県速見郡日出町)

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...


人財教育・人材育成、こだわりと責任範囲

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...


技術系以外の分野は、どう学べば良いか

      今回は、すそ野が広い技術系以外の分野をどう系統づけて学べば良いのかを解説します。     私は、技術士(情報工学部門)ということで...

      今回は、すそ野が広い技術系以外の分野をどう系統づけて学べば良いのかを解説します。     私は、技術士(情報工学部門)ということで...