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

投稿日

技術文書

 

今回は、「内容が明確に伝わる技術文書の書き方の第2原則(内容が明確に伝わる構成を考える)」と「内容が明確に伝わる技術文書の書き方の第3原則(内容が明確に伝わる書き方を考える)」についての解説です。

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

1.「書き方の第2原則」とは

書き方の第2原則とは、内容が明確に伝わる技術文書の構成(骨組み)を考えることです。書き方の第2原則は、内容が明確に伝わる技術文書を具体的に書くうえでのスタートです。内容が明確に伝わる技術文書の構成を考えることで、内容が明確に伝わる技術文書を書くことができます。

 

技術文書

 

内容が明確に伝わる技術文書の構成(骨組み)を考えるうえでのポイントは以下の4つです。

  • ①内容を項目に区分する
  • ②技術文書の軸を決める
  • ③軸となる項目を細分化する
  • ④技術文書のストーリーを確認する

この4つのポイントは、技術文書の枚数や技術文書の種類とは無関係です。どのような技術文書を書くときにもこの4つのポイントに基づき「内容が明確に伝わる技術文書の構成」を考えます。例えば、用紙200枚で書く報告書も用紙1枚で書く会議の資料もこの4つのポイントに基づき構成を考えます。また、メールを書くときにもメールの構成を考えます。

 

2.「書き方の第3原則」とは

書き方の第3原則とは、内容が明確に伝わる書き方を考えることです。すなわち、内容が明確に伝わる技術文書の構成(骨組み)に「6つのルールと18の書き方」を使って肉付けをすることです。

 

2.1 「6つのルールと18の書き方」とは

「6つのルールと18の書き方」を以下に示します。

 

人財教育

 

2.2 「6つのルール」とは

6つのルールとは、内容が明確に伝わる技術文書を書くうえでの書き方の考え方のことです。「冒頭に書く、ペアで書く、分けて書く、視覚的に書く、合わせて書くおよび明確に伝わる文を書く」という6つのルールがあります。

 

2.3 「18の書き方」とは

18の書き方とは、6つのルールに対する具体的な書き方のことです。6つのルールは書き方の考え方なので、この考え方に対応した具体的な書き方が18の書き方です。この18の書き方を使って技術文書の構成に肉付けをします。また、この18の書き方は、報告書、会議や打ち合わせで使う資...

技術文書

 

今回は、「内容が明確に伝わる技術文書の書き方の第2原則(内容が明確に伝わる構成を考える)」と「内容が明確に伝わる技術文書の書き方の第3原則(内容が明確に伝わる書き方を考える)」についての解説です。

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

1.「書き方の第2原則」とは

書き方の第2原則とは、内容が明確に伝わる技術文書の構成(骨組み)を考えることです。書き方の第2原則は、内容が明確に伝わる技術文書を具体的に書くうえでのスタートです。内容が明確に伝わる技術文書の構成を考えることで、内容が明確に伝わる技術文書を書くことができます。

 

技術文書

 

内容が明確に伝わる技術文書の構成(骨組み)を考えるうえでのポイントは以下の4つです。

  • ①内容を項目に区分する
  • ②技術文書の軸を決める
  • ③軸となる項目を細分化する
  • ④技術文書のストーリーを確認する

この4つのポイントは、技術文書の枚数や技術文書の種類とは無関係です。どのような技術文書を書くときにもこの4つのポイントに基づき「内容が明確に伝わる技術文書の構成」を考えます。例えば、用紙200枚で書く報告書も用紙1枚で書く会議の資料もこの4つのポイントに基づき構成を考えます。また、メールを書くときにもメールの構成を考えます。

 

2.「書き方の第3原則」とは

書き方の第3原則とは、内容が明確に伝わる書き方を考えることです。すなわち、内容が明確に伝わる技術文書の構成(骨組み)に「6つのルールと18の書き方」を使って肉付けをすることです。

 

2.1 「6つのルールと18の書き方」とは

「6つのルールと18の書き方」を以下に示します。

 

人財教育

 

2.2 「6つのルール」とは

6つのルールとは、内容が明確に伝わる技術文書を書くうえでの書き方の考え方のことです。「冒頭に書く、ペアで書く、分けて書く、視覚的に書く、合わせて書くおよび明確に伝わる文を書く」という6つのルールがあります。

 

2.3 「18の書き方」とは

18の書き方とは、6つのルールに対する具体的な書き方のことです。6つのルールは書き方の考え方なので、この考え方に対応した具体的な書き方が18の書き方です。この18の書き方を使って技術文書の構成に肉付けをします。また、この18の書き方は、報告書、会議や打ち合わせで使う資料、提案書、企画書、メールなどあらゆる技術文書を書くときに使えます。このことは、例えば、「書き方1は、報告書を書くときにもメールを書くときにも使える」のようなことです。

 

次回に続きます。

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
マンネリからの脱出 (その1)

1.マンネリ化現象とは   カエルを二匹取ってきて、一匹を水を入れた鍋に入れる。その鍋を徐々に温める。温度の変化が徐々であるので、カエルはなんの不安も持...

1.マンネリ化現象とは   カエルを二匹取ってきて、一匹を水を入れた鍋に入れる。その鍋を徐々に温める。温度の変化が徐々であるので、カエルはなんの不安も持...


技術士第二次試験対策:日常業務の中で“文に変換する力”を鍛える

    記述式試験とは、問題を読み頭の中に浮かんだ解答を文に変換しそれを答案用紙に書く内容の試験です。記述式試験は、答案用紙に...

    記述式試験とは、問題を読み頭の中に浮かんだ解答を文に変換しそれを答案用紙に書く内容の試験です。記述式試験は、答案用紙に...


物流技術スタッフを育成する 物流人財育成(その4)

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

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


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

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

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

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


社員教育:日頃の報連相

  1. VIP名簿の大切さ  ブランドメーカーのB社では、書類のファイリングや会議、面談、出張等のスケジューリング管理をすべて社長秘書が担当して...

  1. VIP名簿の大切さ  ブランドメーカーのB社では、書類のファイリングや会議、面談、出張等のスケジューリング管理をすべて社長秘書が担当して...


人はタイミングよく誉めよ -3つの例を添えて-

 私はクリーン化指導で多くの現場に立ち会ってきましたが、どんな業種、職種でも、人財育成はその会社、企業にとっては非常に大切なことです。故に日本では、昔から...

 私はクリーン化指導で多くの現場に立ち会ってきましたが、どんな業種、職種でも、人財育成はその会社、企業にとっては非常に大切なことです。故に日本では、昔から...