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

投稿日

...

技術文書

 

「6つのルールと18の書き方」に関し、「6つのルール」および「18の書き方」の概要について解説しています。「6つのルールと18の書き方」を以下に示します。「6つのルールと18の書き方」の具体的な使い方の解説の続きです。今回も、書き方の使い方の一例を解説します。

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

 

人財教育

 

1.書き方の使い方

1.1 ルール6(明確に伝わる文を書く)について

内容が明確に伝わる技術文書を書くうえで、内容が明確に伝わる文を書くことはその基本となるルールです。すなわち、ルール1からルール5を使ううえでルール6はこれらの基本となるルールです。

 

例えば、書き方1(要点を冒頭に書く)の考え方に基づき結論を冒頭に書いたとします。しかし、冒頭に書いた結論の文の内容が明確に伝わらなかったら書き方1を使った意味がありません。

 

1.2 ルール6(明確に伝わる文を書く)・「書き方13:具体的な文を書く」

書き方13とは、文を読んだときその内容が頭の中に浮かんでくるような具体的な文を書くことです。例えば、以下のような文を読んでも内容が頭の中に浮かんできません。つまり、文の内容が明確に伝わりません。

 

○○駅では、4月から△△線と□□線との乗り換えが同一ホームでできるようになった。その結果、鉄道利用者の利便性が向上した。

 

では、以下の文を読んだらどうでしょうか。

 

○○駅では、4月から△△線と□□線との乗り換えが同一ホームでできるようになった。その結果、乗り換えのための階段での上り下りがなくなり、また、乗り換え時間が約1分短くなったことから鉄道利用者の利便性が向上した。

 

この文を読むと内容が頭の中に浮かんできます。「書き方13:具体的な文を書く」を使って、「鉄道利用者の利便性」に対する具体的な内容を書いたからです。つまり、「鉄道利用者の利便性」を「乗り換えのための階段での上り下りがなくなり、また、乗り換え時間が約1分短くなった」と書いたからです。

 

この他、例えば、「必要に応じて」、「適宜に」あるいは「状況に応じて」という言葉を使った文も内容が頭の中に浮かんできません。

 

例えば、以下のような文を読んでも内容が頭の中に浮かんできません。

 

新型コロナウイルス感染症対策として室内の換気を適宜に行う必要がある。

 

では、以下の文を読んだらどうでしょうか。

 

新型コロナウイルス感染症対策として、2方向の窓を全開にしたうえで、30分に1回以上、数分間程度換気を行う必要がある。

 

この文を読むと内容が頭の中に浮かんできます。「書き方13:具体的な文を書く」を使って、「換気を適宜に行う」に対する具体的な内容を書いたからです。つまり、「2方向の窓を全開にしたうえで、30分に1回以上、数分間程度換気を行う」と書いたからです。

 

次回に続きます。

【参考文献】

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

 

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

 

   続きを読むには・・・


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

もっと見る
説明上手 ~デキるビジネスパーソンのツボ!

  気づかいができるビジネスパーソンは『理解のクセ』をおさえている!これが 説明上手 の科学、LABプロファイル®だ!今回は、チョ...

  気づかいができるビジネスパーソンは『理解のクセ』をおさえている!これが 説明上手 の科学、LABプロファイル®だ!今回は、チョ...


「 見出しを付けるとは 」

1. 記事のテーマをかたまりに分けて書く  2018年4月4日に掲載した記事のテーマは、「かたまりに分けて書く(その2)」でした。この記事の中で、以...

1. 記事のテーマをかたまりに分けて書く  2018年4月4日に掲載した記事のテーマは、「かたまりに分けて書く(その2)」でした。この記事の中で、以...


「話題や相手の気持ちを考えなくても」喜ばれる会話ができる!(初級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その3)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


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

もっと見る
コストを明確にして、評価できる人材を育成する(その1)

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...

 コストを明確にして、評価できる人材を育成する過程を、次のS社を例に、二回に分けて解説します。   1.S社の背景  S社は、印刷機械の受注の窓...


コンプライアンス意識を持とう:職場のマネジメント

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...


伝えることの難しさ

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

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