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

投稿日

技術文書

 

【この連載の前回:内容が明確に伝わる技術文書の書き方(その1)へのリンク】 

「内容が明確に伝わる技術文書を書くための4項目」のうち、まず、「書き方の技術を習得する」について解説します。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。

 

1.内容が明確に伝わる技術文書の書き方の3原則とは

書き方の3原則とは、内容が明確に伝わる技術文書を書くうえでの考え方のことです。書き方の3原則を頭の中に入れて技術文書を書くことで、内容が明確に伝わる技術文書を書くことができます。

 

技術文書

 

2.内容が明確に伝わる技術文書の書き方の3原則の概要

ここで、内容が明確に伝わる技術文書の書き方の3原則の概要を解説します。

 

2.1 書き方の第1原則:書き手と読み手の違いを認識する

書き手とは、技術文書を書く人です。また、“知っている人”です。読み手とは、書き手が書いた技術文書を読む人です。読み手は、書き手からの伝達内容に関する事前の知識(情報)がありません。読み手は、書き手が書いた技術文書を読むことで、初めて、書き手からの伝達内容がわかります。つまり、読み手とは、“知らない人”です。この違いを認識することが書き方の第1原則です。

 

書き手と読み手のこの違いを認識して書くことが、内容が明確に伝わる技術文書を書くうえでのスタートです。

 

2.2 書き方の第2原則:内容が明確に伝わる構成を考える

書き方の第2原則とは、内容が明確に伝わる技術文書の構成(骨組み)を考えることです。内容が明確に伝わる技術文書を書くためには技術文書の構成(技術文書の骨組み)が必要です。これは、家を建てるときには柱や梁などの骨組みが必要なことと同じです。

 

2.3 書き方の第3原則:内容が明確に伝わる書き方を考える

書き方の第3原則とは、内容が明確に伝わる技術文書の構成(骨組み)に肉付けをすることです。“6つのルールと18の書き方”を使って肉付けをします。肉付けをすることで内容が明確に伝...

技術文書

 

【この連載の前回:内容が明確に伝わる技術文書の書き方(その1)へのリンク】 

「内容が明確に伝わる技術文書を書くための4項目」のうち、まず、「書き方の技術を習得する」について解説します。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。

 

1.内容が明確に伝わる技術文書の書き方の3原則とは

書き方の3原則とは、内容が明確に伝わる技術文書を書くうえでの考え方のことです。書き方の3原則を頭の中に入れて技術文書を書くことで、内容が明確に伝わる技術文書を書くことができます。

 

技術文書

 

2.内容が明確に伝わる技術文書の書き方の3原則の概要

ここで、内容が明確に伝わる技術文書の書き方の3原則の概要を解説します。

 

2.1 書き方の第1原則:書き手と読み手の違いを認識する

書き手とは、技術文書を書く人です。また、“知っている人”です。読み手とは、書き手が書いた技術文書を読む人です。読み手は、書き手からの伝達内容に関する事前の知識(情報)がありません。読み手は、書き手が書いた技術文書を読むことで、初めて、書き手からの伝達内容がわかります。つまり、読み手とは、“知らない人”です。この違いを認識することが書き方の第1原則です。

 

書き手と読み手のこの違いを認識して書くことが、内容が明確に伝わる技術文書を書くうえでのスタートです。

 

2.2 書き方の第2原則:内容が明確に伝わる構成を考える

書き方の第2原則とは、内容が明確に伝わる技術文書の構成(骨組み)を考えることです。内容が明確に伝わる技術文書を書くためには技術文書の構成(技術文書の骨組み)が必要です。これは、家を建てるときには柱や梁などの骨組みが必要なことと同じです。

 

2.3 書き方の第3原則:内容が明確に伝わる書き方を考える

書き方の第3原則とは、内容が明確に伝わる技術文書の構成(骨組み)に肉付けをすることです。“6つのルールと18の書き方”を使って肉付けをします。肉付けをすることで内容が明確に伝わる技術文書が完成します。

 

技術文書

 

次回に続きます。

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
改善魂に火を着け改善力を高めるには、失敗を恐れない安心感が大切!

     【目次】 今回は、改善魂に火を着け改善力を高めるには、失敗を恐れない安心感が大切と言う話題で...

     【目次】 今回は、改善魂に火を着け改善力を高めるには、失敗を恐れない安心感が大切と言う話題で...


A3判の用紙1枚で作成した概要版の利用方法

 2018年6月1日に掲載された記事(A3判の用紙1枚で概要版を作成する)では、A3判の用紙1枚で業務の概要版を作成することについて書きました。   ...

 2018年6月1日に掲載された記事(A3判の用紙1枚で概要版を作成する)では、A3判の用紙1枚で業務の概要版を作成することについて書きました。   ...


研修成果の出る組織と出ない組織はどこが違うのか、効果を高めるには

  今回は、研修効果を出す組織についておはなしします。研修効果を最大にするノウハウがここにあります。   【目次】1. 研修...

  今回は、研修効果を出す組織についておはなしします。研修効果を最大にするノウハウがここにあります。   【目次】1. 研修...


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

もっと見る
「生産性底上げ時代」のモノづくり戦略 - 協働型スマート工場で、勝ち筋の見える三位一体の製造DXを ―

  生産性向上に取り組まなければ、生き残れない時代に 早稲田大学 研究院教授 藤本 隆宏 氏 【目次】 付加価値の良...

  生産性向上に取り組まなければ、生き残れない時代に 早稲田大学 研究院教授 藤本 隆宏 氏 【目次】 付加価値の良...


人財教育・人材育成、行動範囲が広いということは自分の裁量や権限で仕事ができること

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...


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

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

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