内容が明確に伝わる技術文書の書き方(その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. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...

【目次】 1. 固執、本人が自覚することが固執から解放される一番の方法 「なんとか自力で解決しよう」とやっきになっても、焦ってばか...


名選手、名監督にあらず:物流管理者の育て方(その1)

  ◆ 名選手、名監督にあらず 昔から「名選手、名監督にあらず」ということが言われています。プロ野球でもよくあることです。一流選手が監督...

  ◆ 名選手、名監督にあらず 昔から「名選手、名監督にあらず」ということが言われています。プロ野球でもよくあることです。一流選手が監督...


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

    やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。   これまで...

    やろうと思っているけどできないことでモヤモヤしている気持ち。そんな気持ちを克服する方法の3回目です。   これまで...