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

投稿日

技術文書

 

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

下図の「内容が明確に伝わる技術文書の書き方第1原則」は、技術文書を書くうえで最も重要な原則です。今回は、“ことわざ”と書き方の第1原則との関係の2回目です。

 

技術文書

 

1.己の欲せざる所は人に施す勿れ

例えば、報告書に以下のような書き方をした箇所があったらどうでしょうか。

 

【車の主な種類】

ハイブリッドとは、ガソリンで動くエンジンと、電気で動くモーターを搭載している車のことです。モーターがエンジンをサポートして走るため燃費がよく、ガソリン仕様車と比べて排出するCO2が軽減されるため、環境への影響が小さいのがこの車の特長です。コンパクトとは、ボディサイズが小さめで、排気量が小さなエンジンを積んだ車のことです。セダンやミニバンと比べてボディサイズが小さめなので取り回しがよく、狭い路地や駐車場でも気を使うことなく運転できることがこの車の特長です。セダンとは、エンジンルーム、乗車空間、荷物空間が別々になっている形をしていて、車の基本とも呼ばれるタイプの車のことです。乗車空間が荷物空間から独立していることから、乗る人の快適性を重視した居住空間が確保され、移動するのに適しているのがこの車の特長です。

筆者注:「車の主な種類」の内容は、「HONDA」のウェブサイトを参考にさせていただきました。

 

これを読むと、「文の羅列で書いてあるので内容がわかりにくい(内容が明確に伝わらない)。内容がわかりやすくなるように(内容が明確に伝わるように)、もう少し書き方を工夫してほしい。読み手のことを考えて書いてほしい」のような感想になると思います。

 

ここで参考になるのが、「己の欲せざる所は人に施す勿れ」という“ことわざ”です。「己の欲せざる所は人に施す勿れ」とは、自分がしてほしくないと思うことは、他人にとっても同じなのだから、他人にすべきではないという教えです。

 

これを、技術文書を書く場合に当てはめると、「自分が読んでわかりにくい(内容が明確に伝わらない)と思うような技術文書は、読み手にとってもわかりにくいはずだ。そのため、自分が読んでわかりにくいと思う技術文書を書くべきではない」という解釈になります。

 

つまり、「文の羅列で書いた内容を読み手の立場に立って読んでみるとわかりにくい(内容が明確に伝わらない)と思う。自分が読んでわかりにくい(内容が明確に伝わらない)のだから読み手にとってもわかりにくいだろう。そのため、文の羅列で内容を書くべきではない」という解釈になります。

 

前回と今回で紹介した「我が身をつねって人の痛さを知れ」と「己の欲せざる所は人に施す勿れ」という...

技術文書

 

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

下図の「内容が明確に伝わる技術文書の書き方第1原則」は、技術文書を書くうえで最も重要な原則です。今回は、“ことわざ”と書き方の第1原則との関係の2回目です。

 

技術文書

 

1.己の欲せざる所は人に施す勿れ

例えば、報告書に以下のような書き方をした箇所があったらどうでしょうか。

 

【車の主な種類】

ハイブリッドとは、ガソリンで動くエンジンと、電気で動くモーターを搭載している車のことです。モーターがエンジンをサポートして走るため燃費がよく、ガソリン仕様車と比べて排出するCO2が軽減されるため、環境への影響が小さいのがこの車の特長です。コンパクトとは、ボディサイズが小さめで、排気量が小さなエンジンを積んだ車のことです。セダンやミニバンと比べてボディサイズが小さめなので取り回しがよく、狭い路地や駐車場でも気を使うことなく運転できることがこの車の特長です。セダンとは、エンジンルーム、乗車空間、荷物空間が別々になっている形をしていて、車の基本とも呼ばれるタイプの車のことです。乗車空間が荷物空間から独立していることから、乗る人の快適性を重視した居住空間が確保され、移動するのに適しているのがこの車の特長です。

筆者注:「車の主な種類」の内容は、「HONDA」のウェブサイトを参考にさせていただきました。

 

これを読むと、「文の羅列で書いてあるので内容がわかりにくい(内容が明確に伝わらない)。内容がわかりやすくなるように(内容が明確に伝わるように)、もう少し書き方を工夫してほしい。読み手のことを考えて書いてほしい」のような感想になると思います。

 

ここで参考になるのが、「己の欲せざる所は人に施す勿れ」という“ことわざ”です。「己の欲せざる所は人に施す勿れ」とは、自分がしてほしくないと思うことは、他人にとっても同じなのだから、他人にすべきではないという教えです。

 

これを、技術文書を書く場合に当てはめると、「自分が読んでわかりにくい(内容が明確に伝わらない)と思うような技術文書は、読み手にとってもわかりにくいはずだ。そのため、自分が読んでわかりにくいと思う技術文書を書くべきではない」という解釈になります。

 

つまり、「文の羅列で書いた内容を読み手の立場に立って読んでみるとわかりにくい(内容が明確に伝わらない)と思う。自分が読んでわかりにくい(内容が明確に伝わらない)のだから読み手にとってもわかりにくいだろう。そのため、文の羅列で内容を書くべきではない」という解釈になります。

 

前回と今回で紹介した「我が身をつねって人の痛さを知れ」と「己の欲せざる所は人に施す勿れ」という“ことわざ”は相手のことを思いやる内容です。

 

書き方の3原則での第1原則(書き手と読み手の違いを認識する)も読み手のことを思いやる内容です。

 

次回に続きます。

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

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

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


意外と陥りがちな作業手順書づくりの落とし穴とは、

    今回は、教育指導の時に使う、作業手順書のおはなしです。   1. 意外と陥りがちな、作業手順書づくりの落とし...

    今回は、教育指導の時に使う、作業手順書のおはなしです。   1. 意外と陥りがちな、作業手順書づくりの落とし...


OJCCとは(3)総合力の育成 【快年童子の豆鉄砲】(その103)

        1. 企業が社員に求める能力10項目の最初、総合力 育成ステップ説明の最初は、表84-1...

        1. 企業が社員に求める能力10項目の最初、総合力 育成ステップ説明の最初は、表84-1...


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

もっと見る
「やろうと思っているけどできないことばかり」の克服(その2)

      やろうと思っていることがたくさんあるのに、できないことばかり。前回から、そんな状態にモヤモヤしていると...

      やろうと思っていることがたくさんあるのに、できないことばかり。前回から、そんな状態にモヤモヤしていると...


QFD(品質機能展開)で人財開発施策を俯瞰

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...


‐能力開発のシステム創り 製品・技術開発力強化策の事例(その47)

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その46に続いて解説します。      (1) 情報伝達の仕組み創り   (2) 目標を明確...

◆能力開発のシステム化に必要不可欠の条件。   前回の事例その46に続いて解説します。      (1) 情報伝達の仕組み創り   (2) 目標を明確...