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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
相手をその気にさせる労働安全衛生マネジメントとは

    1.対話術 伝える難しさをどう乗り越えるか 「言葉だけで 作業を説明され、 それを実施してみて欲しい」と言われたら、...

    1.対話術 伝える難しさをどう乗り越えるか 「言葉だけで 作業を説明され、 それを実施してみて欲しい」と言われたら、...


成果主義のメリットとメンタルヘルス

 事務職や専門職など「ホワイトカラー」を対象に、週40時間といった労働時間規制の適用を外し、成果に見合った給与を支払う「ホワイトカラー・エグゼンプション」...

 事務職や専門職など「ホワイトカラー」を対象に、週40時間といった労働時間規制の適用を外し、成果に見合った給与を支払う「ホワイトカラー・エグゼンプション」...


外国人研修生の上手い活用法

1、外国人研修生を活用する課題  私が25年以上に渡り、海外及び日本で外国人の方々と仕事を進めてくる中で経験し、感じ、学んで来た、外国人と上手く仕事を進...

1、外国人研修生を活用する課題  私が25年以上に渡り、海外及び日本で外国人の方々と仕事を進めてくる中で経験し、感じ、学んで来た、外国人と上手く仕事を進...


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

もっと見る
品質管理教育の重要ポイント

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...


 PDCA サイクルとシステム手帳

  今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「え...

  今回は、「スケジュールやタスクをどうやって管理しているのか」という話題です。僕が「フランクリン・プランナーを使っている」と言うと、皆が「え...


‐能力開発のシステム創り 製品・技術開発力強化策の事例(その47)

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その46に続いて解説します。      (1) 情報伝達の仕組み創り   (2) 目標を明確...

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その46に続いて解説します。      (1) 情報伝達の仕組み創り   (2) 目標を明確...