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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
「話題や相手の気持ちを考えなくても」喜ばれる会話ができる!(初級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その3)

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


動機付けの大切さ ~ 改善は「テクニック」だけではない。

    1.改善の滞り・マンネリ化を 動機付け で解消! 改善活動の展開において現場がヤル気になったのに、マネジメント側でブ...

    1.改善の滞り・マンネリ化を 動機付け で解消! 改善活動の展開において現場がヤル気になったのに、マネジメント側でブ...


責任感と当事者意識の育成法

  ◆責任感と当事者意識は、仕事をする上でとても大切 あなたの職場では 責任感と当事者意識といった言葉が、使われることがありませんか?例...

  ◆責任感と当事者意識は、仕事をする上でとても大切 あなたの職場では 責任感と当事者意識といった言葉が、使われることがありませんか?例...


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

もっと見る
人財教育・人材育成、固執、本人が自覚することが固執から解放される一番の方法

【目次】 1. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...

【目次】 1. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...


『わかりにくい案内図』から学ぶこと

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...


  物流作業者変更時の留意点とは:物流4M管理の重要性(その2)

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...

  ◆ 物流作業者変更時の留意点  人に関しては毎年個人単位にどのような分野を教えていくのかを明確にしていきましょう。そして習熟計画を作...