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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
文書の書き方(文書の内容)をチェックするうえでのポイント

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...

1. 文書の書き方(文書の内容)をチェックするうえでのポイント  「『君の書いた文書はわかりにくい』と言われないためにやるべきこと 」の記事の中で以...


「文書を書くことができるが、わかりやすい文書を書くことができない」について

  1. IT分野の技術者の方々について  「森谷さん、IT分野の仕事に従事する技術者の中で文書を書くことができない技術者は多いですよ・・・」 ...

  1. IT分野の技術者の方々について  「森谷さん、IT分野の仕事に従事する技術者の中で文書を書くことができない技術者は多いですよ・・・」 ...


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

  1.「書き方の3原則」と「6つのルールと18の書き方」の習得が条件 技術文書を書く面白さを知り技術文書を工夫して書くための条件は「内...

  1.「書き方の3原則」と「6つのルールと18の書き方」の習得が条件 技術文書を書く面白さを知り技術文書を工夫して書くための条件は「内...


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

もっと見る
提案制度の考察、参加しやすいルールとは、継続できるしくみとは

      1. 参加しやすいルールとは メーカーでは全従業員が毎月何かしらの提案を行っている会社が多いと思います。メーカーで...

      1. 参加しやすいルールとは メーカーでは全従業員が毎月何かしらの提案を行っている会社が多いと思います。メーカーで...


世界をリードするモノづくり中小企業の人づくり

 以前、東京国際フォーラムで東京理科大主催のパネルディスカッションが開催されました。テーマは「ニッチトップで世界をリードする日本のモノ作り企業」。株式会社...

 以前、東京国際フォーラムで東京理科大主催のパネルディスカッションが開催されました。テーマは「ニッチトップで世界をリードする日本のモノ作り企業」。株式会社...


【SDGs取り組み事例】環境対策を基盤に、働き甲斐と経済成長を実現 株式会社エフピコ

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...

サステナブルな社会を目指した“人の輪づくり” 地球温暖化など環境問題が重要な社会課題として世界的に認識され、その保護気運の高...