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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
スピーチの悩みを心理学で解決、スマートトークのコツとは

【目次】 先日、お客様と話をしているとき、こんなことを話されていました。その方は、長年の努力の末に手掛けた、新製品の発表イベントに立...

【目次】 先日、お客様と話をしているとき、こんなことを話されていました。その方は、長年の努力の末に手掛けた、新製品の発表イベントに立...


マンネリからの脱出 (その2)

3.マンネリ対策にはどんなものがあるだろうか  マンネリから脱却するには、まず頭をつねにプラス方向に回転させなければならなりません。プラス思考の六つの基...

3.マンネリ対策にはどんなものがあるだろうか  マンネリから脱却するには、まず頭をつねにプラス方向に回転させなければならなりません。プラス思考の六つの基...


部下のやる気を引き出すコーチングとは

  いくら品質管理の仕組みを作ったり、教育訓練を行っても、行動出来ない部下が多いようです。業務改善がなかなか進まないと悩んでいる管理層の方も多...

  いくら品質管理の仕組みを作ったり、教育訓練を行っても、行動出来ない部下が多いようです。業務改善がなかなか進まないと悩んでいる管理層の方も多...


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

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

  やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよく...

  やろうと思っているけどできないことってありますね。ぼくもやろうと思っていることがたくさんあるのにできないことばかりです。コーチングでもよく...


「相手中心」で喜ばれる会話と怒りをよぶ会話の具体例

    【目次】   1. 押しつけは怒りを呼ぶ。だったら、相手に任せればいい? 「A案とB案...

    【目次】   1. 押しつけは怒りを呼ぶ。だったら、相手に任せればいい? 「A案とB案...


人財教育・人材育成、行動範囲が広いということは自分の裁量や権限で仕事ができること

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...