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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
物流IEを育成する(前編) 物流人財育成(その2)

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

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


研修講師に必要なスキルとは

  1.研修講師に必要なスキルは、専門性だけではない 研修講師を選ぶ場合、実績はもちろん、その専門性を見極めて選択することが大切です。し...

  1.研修講師に必要なスキルは、専門性だけではない 研修講師を選ぶ場合、実績はもちろん、その専門性を見極めて選択することが大切です。し...


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

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

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


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

もっと見る
引き継ぎ資料で押さえるポイントとは

 四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料の作成で押さえ...

 四半期末や年度末、退職のタイミングで自身の業務を次の担当者に引き継ぐことは誰しも経験があるのではないでしょうか。今回は業務引き継ぎ資料の作成で押さえ...


【SDGs取組み事例】事業性質にとらわれず、“SDGsに貢献可能なものは何か”を皆で考える エスティーティー株式会社(神奈川県秦野市)

目次 1.従業員の意識改革や職場環境の整備などに取り組む2.リサイクル装置設け、有機溶剤のリサイクルを開始3.塗装前処理工程を全自動化4.キャリアア...

目次 1.従業員の意識改革や職場環境の整備などに取り組む2.リサイクル装置設け、有機溶剤のリサイクルを開始3.塗装前処理工程を全自動化4.キャリアア...


「気づき」の仕組み 擦り合わせ型開発 基本の仕組み (その2)

【目指すべき開発体制 連載目次】 目指すべき開発体制とは(その1)擦り合わせ型と組み合わせ型 目指すべき開発体制とは(その2)日本企業文化を引きず...

【目指すべき開発体制 連載目次】 目指すべき開発体制とは(その1)擦り合わせ型と組み合わせ型 目指すべき開発体制とは(その2)日本企業文化を引きず...