内容が明確に伝わる技術文書の書き方(その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. 何を書いたらいいのかわからない  例えば、「“人生論”についてのあなたの考えを2,000文字以内でまとめて提出しなさい」のような課題が与えられ...

1. 何を書いたらいいのかわからない  例えば、「“人生論”についてのあなたの考えを2,000文字以内でまとめて提出しなさい」のような課題が与えられ...


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

  ◆会議でうまく説明する方法(その2) 「内容が明確に伝わる技術文書の書き方(その44)」の中で「会話をすることも技術文書を書くことも...

  ◆会議でうまく説明する方法(その2) 「内容が明確に伝わる技術文書の書き方(その44)」の中で「会話をすることも技術文書を書くことも...


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

もっと見る
人的資源マネジメント:自分の「徳」を知って成果を出す(その1)

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...


人財教育・人材育成、まず行動、変化はすぐに表れない

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...


【インタビュー】ダイバーシティは企業存続に必要不可欠!  取り組みに懸ける思いと国内企業の現状

パナソニック コネクト株式会社取締役 執行役員 山口有希子氏  ヤンマーホールディングス株式会社取締役CSO 長田志織氏  ...

パナソニック コネクト株式会社取締役 執行役員 山口有希子氏  ヤンマーホールディングス株式会社取締役CSO 長田志織氏  ...