内容が明確に伝わる技術文書の書き方(その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. 聞き手の立場になってわかりやすく説明しよう    先日、技術者の方を対象とした研修会で講師を務めてきました。研修会のテーマは...


OJCCとは(9)改善提案能力の育成 【快年童子の豆鉄砲】(その109)

  1. 意識・意欲の存在 これまで説明してきたのは、現在の仕事遂行に必要な“能力”(「仕事に関する知識(B)」...

  1. 意識・意欲の存在 これまで説明してきたのは、現在の仕事遂行に必要な“能力”(「仕事に関する知識(B)」...


アクティブラーニング、文科省が推進する理由をわかりやすく解説

  第4次産業革命が進行中の現代、AI・IoT・DX技術などの発達で、何を創るかのフロントランナーの時代へとパラダイムシフトしています。企...

  第4次産業革命が進行中の現代、AI・IoT・DX技術などの発達で、何を創るかのフロントランナーの時代へとパラダイムシフトしています。企...


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

もっと見る
「やろうと思っているけどできないことばかり」の克服(その2)

      やろうと思っていることがたくさんあるのに、できないことばかり。前回から、そんな状態にモヤモヤしていると...

      やろうと思っていることがたくさんあるのに、できないことばかり。前回から、そんな状態にモヤモヤしていると...


職場の活動を人財育成と職場活性化の場にするには

 私が勤務していた会社では、「安全衛生推進パトロール」というものがありました。職場ごと、毎月当番制で、所属する職場を巡回し、安全面や3S、5Sの面でパトロ...

 私が勤務していた会社では、「安全衛生推進パトロール」というものがありました。職場ごと、毎月当番制で、所属する職場を巡回し、安全面や3S、5Sの面でパトロ...


「やろうと思っているけどできないことばかり」の克服(その4)

    前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、や...

    前回は絞り込んでもなお、やりたいけどできないことに対して心理的抵抗を整理しました。ちょっと面倒だったと思いますけど、や...