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

投稿日

技術文書

 

1.解説した“書き方”の整理

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「内容が明確に伝わる技術文書の書き方(その12)から(その18)」で「6つのルールと18の書き方」の具体的な使い方の一例を解説しました。今回は、この7回で解説した“書き方”を整理します。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その18)へのリンク】 

人財教育

 

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

 ①ルール1(冒頭に書く)・「書き方1:要点を冒頭に書く」

 *その13は、「書き方の第2原則(内容が明確に伝わる構成を考える)」と「書き方1(要点を冒頭に書く)」の組み合わせでの書き方

 

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

 ①ルール3(分けて書く)・「書き方6:かたまりに分けて書く」

 ②ルール4(視覚的に書く)・「書き方10:強調して書く」

 

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

 ①ルール3(分けて書く)・「書き方8:表で書く」

 ②ルール4(視覚的に書く)・「書き方9:写真や図を入れて書く」

 ③ルール4(視覚的に書く)・「書き方10:強調して書く」

 

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

 ①ルール6(明確に伝わる文を書く)・「書き方13:具体的な文を書く」

 

(5)内容が明確に伝わる技術文書の書き方(その17・その18)

 ①ルール6(明確に伝わる文を書く)・「書き方16:短い文を書く(一文一義で書く)」

 

このように、「6つのルールと18の書き方」を使って書くことで内容が明確に伝わる技術文書を書くことができます。ここで解説しなかったこれら以外の書き方を使っても内容が明確に伝わる技術文書を書くことができます。

 

2.「書き方2:全体像を冒頭に書く」について

今回は、「ルール1(冒頭に書く)」について、「書き方1:要点を冒頭に書く」だけを対象にしてその具体的な書き方の例を解説しました。「書き方2:全体像を冒頭に書く」の具体的な書き方の例は、2018年9月18日に掲載した「『全体から詳細へ』の考え...

技術文書

 

1.解説した“書き方”の整理

「6つのルールと18の書き方」に関し「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「内容が明確に伝わる技術文書の書き方(その12)から(その18)」で「6つのルールと18の書き方」の具体的な使い方の一例を解説しました。今回は、この7回で解説した“書き方”を整理します。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その18)へのリンク】 

人財教育

 

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

 ①ルール1(冒頭に書く)・「書き方1:要点を冒頭に書く」

 *その13は、「書き方の第2原則(内容が明確に伝わる構成を考える)」と「書き方1(要点を冒頭に書く)」の組み合わせでの書き方

 

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

 ①ルール3(分けて書く)・「書き方6:かたまりに分けて書く」

 ②ルール4(視覚的に書く)・「書き方10:強調して書く」

 

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

 ①ルール3(分けて書く)・「書き方8:表で書く」

 ②ルール4(視覚的に書く)・「書き方9:写真や図を入れて書く」

 ③ルール4(視覚的に書く)・「書き方10:強調して書く」

 

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

 ①ルール6(明確に伝わる文を書く)・「書き方13:具体的な文を書く」

 

(5)内容が明確に伝わる技術文書の書き方(その17・その18)

 ①ルール6(明確に伝わる文を書く)・「書き方16:短い文を書く(一文一義で書く)」

 

このように、「6つのルールと18の書き方」を使って書くことで内容が明確に伝わる技術文書を書くことができます。ここで解説しなかったこれら以外の書き方を使っても内容が明確に伝わる技術文書を書くことができます。

 

2.「書き方2:全体像を冒頭に書く」について

今回は、「ルール1(冒頭に書く)」について、「書き方1:要点を冒頭に書く」だけを対象にしてその具体的な書き方の例を解説しました。「書き方2:全体像を冒頭に書く」の具体的な書き方の例は、2018年9月18日に掲載した「『全体から詳細へ』の考え方でまとめる」の記事を参考にしてください。「全体から詳細へ」も、内容が明確に伝わる技術文書を書くうえで有効な書き方です。

 

次回に続きます。

【参考文献】

森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日

 

関連解説記事「相手の立場に立って考える」こと 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
「ネガティブな内容が含まれる報告書、企画書、認可書類を一瞬で合意する」形容詞化戦略(上級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その7)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


エンジニアが出版で失敗する原因と対策

        皆さんは論文や報告書を書いた経験がありますか? 今回は、仕事で報告書を書ているエンジニアが本の出版で失敗する原因と成功の対策について...

        皆さんは論文や報告書を書いた経験がありますか? 今回は、仕事で報告書を書ているエンジニアが本の出版で失敗する原因と成功の対策について...


物流技能向上プログラムの導入 物流人財育成(その6)

  【物流人財育成 連載目次】 1.物流マンへの期待値 2.物流IEを育成する 3.物流技術スタッフを育成する 4.物流現場管理を...

  【物流人財育成 連載目次】 1.物流マンへの期待値 2.物流IEを育成する 3.物流技術スタッフを育成する 4.物流現場管理を...


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

もっと見る
【ものづくりの現場から】クラフト体験を技術者教育に活用(クラフト・ミー)

【特集】ものづくりの現場から一覧へ戻る ものづくりを現場視点で理解する「シリーズ『ものづくりの現場から』」では、現場の課題や課題解消に向けた現場の取り組...

【特集】ものづくりの現場から一覧へ戻る ものづくりを現場視点で理解する「シリーズ『ものづくりの現場から』」では、現場の課題や課題解消に向けた現場の取り組...


人財教育・人材育成、自分と相手を区別してしまった結果の泥沼化

【目次】 1. 区別 私たちは日常生活の中で色々な区別をします。若者と年配、上司と部下など様々です。仕事の場合は役割によって区別す...

【目次】 1. 区別 私たちは日常生活の中で色々な区別をします。若者と年配、上司と部下など様々です。仕事の場合は役割によって区別す...


人財教育・人材育成、流れを変えるために行動して自分を客観的に見る

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

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