内容が明確に伝わる技術文書の書き方(その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. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ心理...

【ポジティブ心理学 連載目次】 1. イキイキ感をプラスにする!「ポジティブ心理学」【出会い編】 2. イキイキ感をプラスにする!「ポジティブ心理...


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

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

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


『記憶術』で記憶力の活性化、思い出す力を鍛えよう

  今回は、リスキリングを助ける『記憶術』についておはなしします。あなたの記憶力が活性化されます。   1. 記憶力は誰もが...

  今回は、リスキリングを助ける『記憶術』についておはなしします。あなたの記憶力が活性化されます。   1. 記憶力は誰もが...


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

もっと見る
部下の育成とは:物流管理者の育て方(その3)

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...

  ◆ 部下の育成 皆さんの会社の物流管理者は部下の育成をしっかりとできていますでしょうか。自部門で必要なスキルを棚卸し、それを確実にで...


社員教育:日頃の報連相

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

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


自部門の数値把握:物流管理者の育て方(その2)

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...