内容が明確に伝わる技術文書の書き方(その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. 生活の中の数値化  “ぼんやり”が“はっきり”に変わることで行動が変わることがあります。ここでは、“はっきり”を“数値化”という言葉に置き換え...


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

  「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方...

  「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方...


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

【目次】 1. 好きこそものの上手なれ 「好きこそものの上手なれ」ということわざがあります。「人は自分が好きなことなら進んで工夫し...

【目次】 1. 好きこそものの上手なれ 「好きこそものの上手なれ」ということわざがあります。「人は自分が好きなことなら進んで工夫し...


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

もっと見る
伝えることの難しさ

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...


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

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

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


人財教育・人材育成、 周囲の反応、強みと弱み、自己評価と周囲の評価が一致していない時

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! 1. 周囲の反応、自分のことは自分が一番見えていない 自...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! 1. 周囲の反応、自分のことは自分が一番見えていない 自...