内容が明確に伝わる技術文書の書き方(その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日

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
人財育成(その14) クリーン化について(その109)

  ◆褒めることの大切さ 定年退職をしてしばらく経ちます。体力、気力ともかなり衰えてきました。それを日々実感しています。ただ、ものづくり...

  ◆褒めることの大切さ 定年退職をしてしばらく経ちます。体力、気力ともかなり衰えてきました。それを日々実感しています。ただ、ものづくり...


技術文書を書く面白さを知る(技術文書を工夫して書く)(その3)

   【目次】 1. 書き手の考え方で結果が異なる 以前、弊社が講師を務めたセミナーを受講された方の中で希望され...

   【目次】 1. 書き手の考え方で結果が異なる 以前、弊社が講師を務めたセミナーを受講された方の中で希望され...


研究開発に威力を発揮するモチベーション理論

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...

1.モチベ―ションをどう捉えるか  かつて、バブルの全盛期に、新卒を採用するためにいろいろな特典を用意していたことを覚えているでしょうか。車を買ってあげ...


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

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

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

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


スモールスタートで始めるDX ~ PDCAサイクル高速化で品質・生産性向上

  デジタル技術で現場リーダーの身近な課題を解決 高崎ものづくり技術研究所 濱田 金男氏 【目次】 【アーカイブ動画のご...

  デジタル技術で現場リーダーの身近な課題を解決 高崎ものづくり技術研究所 濱田 金男氏 【目次】 【アーカイブ動画のご...


【SDGs取り組み事例】ダイバーシティ経営で人的資源を最適化 有限会社川田製作所

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...