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

投稿日

...

技術文書

 

「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「内容が明確に伝わる技術文書の書き方(その14)」の続きです。前回は、文の羅列で書いた内容を、「書き方6:かたまりに分けて書く」を使って書きました。今回は、これと異なる書き方で書いた場合の解説です。

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

 

人財教育

 

1.パターンⅡ :ルール3(分けて書く)・「書き方8:表で書く」

パターンⅡ注)は、文の羅列で書いた内容を、「ルール3(分けて書く)・『書き方8:表で書く』」を使って書きました。結果を以下に示します。注):「内容が明確に伝わる技術文書の書き方(その14)」で書いた書き方(書き方6:かたまりに分けて書く)をパターンⅠとします。

 

人財教育

 

書き方8を使って表で書く場合、表の内容を一層明確に伝える方法として「書き方10:強調して書く」を使い重要な内容を強調して書きました。以下が強調して書いた内容です。

 

① 表のタイトル(「表 車の種類・定義・特長」)と表の項目(車の種類・定義・特長)を強調して書く。

*フォントをゴシック体にする。

 

② 定義および特長での重要な内容を強調して書く。

*アンダーラインを付ける。

 

2.パターンⅢ:ルール3(分けて書く)・「書き方8:表で書く」+ルール4(視覚的に書く)・「書き方9:写真や図を入れて書く」

パターンⅢは、「ルール3(分けて書く)・『書き方8:表で書く』」と「ルール4(視覚的に書く)・『書き方9:写真や図を入れて書く』」を組み合わせて書きました。結果を以下に示します。また、書き方8を使って表で書く場合、パターンⅡと同様に「書き方10:強調して書く」を使って重要な内容を強調して書きました。 

 

人財教育

 

3.まとめ

「内容が明確に伝わる技術文書の書き方(その14)」と「同(その15)」で、文の羅列で書いた内容を以下の3パターンで書きました。

  • ①パターンⅠ:「書き方6:かたまりに分けて書く」+「書き方10:強調して書く」
  • ②パターンⅡ:「書き方8:表で書く」+「書き方10:強調して書く」
  • ③パターンⅢ:「書き方8:表で書く」+「書き方9:写真や図を入れて書く」+「書き方10:強調して書く」


文の羅列で書いた内容をこれらの3パターンの書き方で書くことで内容が明確に伝わります。文の羅列で書いた内容を内容が明確に伝わるように書く場合、内容によっては、「書き方7:箇条書きで書く」を使って書くこともできます。内容が明確に伝わる技術文書を書く場合には、伝える内容に基づき、「6つのルールと18の書き方」の中から書き方を選んで技術文書を書きます。

 

次回に続きます。

【参考文献】

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

 

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

 

   続きを読むには・・・


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

もっと見る
ルールの周知徹底ができないのはなぜか、周知徹底に必要なこと

  「安全衛生や品質保全などのルールを制定したが、なかなか全員がそれを守ってくれない。」ルールの周知徹底 ができない・・・・。そのほとんど...

  「安全衛生や品質保全などのルールを制定したが、なかなか全員がそれを守ってくれない。」ルールの周知徹底 ができない・・・・。そのほとんど...


人財育成(その11) クリーン化について(その106)

  毎年、5月をむかえると新入社員が入社して1ヶ月が経ちます。現在社員教育中のところもあれば、現場で即戦力として働いている場合もあるでしょ...

  毎年、5月をむかえると新入社員が入社して1ヶ月が経ちます。現在社員教育中のところもあれば、現場で即戦力として働いている場合もあるでしょ...


動機付けでチームの安全意識を高めるには

  私たちの行動は、モチベーションの高さで決まります。モチベーションが高ければ、意識も高まり、その行動の『質』が高まると同時にパフォーマン...

  私たちの行動は、モチベーションの高さで決まります。モチベーションが高ければ、意識も高まり、その行動の『質』が高まると同時にパフォーマン...


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

もっと見る
【SDGs取り組み事例】ダイバーシティ経営で人的資源を最適化 有限会社川田製作所

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 有限会社川田製作所(神奈川県小田原市) 目次 1.多様性(ダイバ...

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 有限会社川田製作所(神奈川県小田原市) 目次 1.多様性(ダイバ...


伝えることの難しさ

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...

1. 自分では当たり前でも、相手にとっては当たり前ではないことだらけ  人前で話をする機会が増えましたが、その都度、話すこと、伝えることの難しさを感...


『わかりにくい案内図』から学ぶこと

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...

1. 案内図の表示が上下逆さま  弊社は埼玉県所沢市にあります。昨年の夏頃、所沢駅西口の駅前の交差点に写真①のような案内板が設置されました。この案内...