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

投稿日

技術文書

 

 

今回から、「6つのルールと18の書き方」に関する補足解説をします。今回は、「ルール1:冒頭に書く」の中の「書き方1:要点を冒頭に書く」に関する補足解説です。「書き方1:要点を冒頭に書く」と「ネットでの検索とその検索結果」の関係です。

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

人財教育

1.「〇〇とは」と検索する

何かを調べるときネットを使う方も多いと思います。そのとき「〇〇とは」と入力し検索する方もいると思います。例えば、2023年10月1日から導入される「インボイス制度」について調べたいとき「インボイス制度とは」と打ち込み検索することです。実際に「インボイス制度とは」と打ち込んで検索してみると、あるウェブサイトでは次のような説明が書いてあります。

 

インボイス制度とは、軽減税率により複数の税率ができたとき、仕入れ税額控除に適格請求書(インボイス)などの保存が要件となる制度です。』

 

このウェブサイトでは、「インボイス制度とは」という検索に対して、ウェブサイトの冒頭で、「インボイス制度とは・・・です」のように検索結果を簡潔に説明しています。つまり、ウェブサイトの冒頭で、インボイス制度の要点を簡潔に説明しています。また、「インボイス制度とは・・・です」という説明の後にインボイス制度について詳しく説明しています。

 

このウェブサイトは、「インボイス制度とは」という質問に対して内容が明確に伝わる解説をしています。

 

これは、「書き方1:要点を冒頭に書く」の書き方です。「書き方1:要点を冒頭に書く」とは、「内容に関する要点を冒頭に書き、この要点に関する説明をその後に書くこと」だからです。また、これは、「内容が明確に伝わる技術文書の書き方(その12)」で書いた以下の書き方と同じです。

 

【パターンⅡ】

1.〇〇交差点の改良計画の目的

〇〇交差点をスクランブル交差点に改良することが今回の〇〇交差点の改良計画の目的である。〇〇交差点では、歩行者や自転車と左折車との接触事故が毎年数件発生している。過去には歩行者の死亡事故も発生している。来年3月末には、〇〇交差点付近に大型ショッピングセンターができることから、〇〇交差点を利用する歩行者や自転車が増えると予想できる。そのため、歩行者や自転車の安全確保のため〇...

技術文書

 

 

今回から、「6つのルールと18の書き方」に関する補足解説をします。今回は、「ルール1:冒頭に書く」の中の「書き方1:要点を冒頭に書く」に関する補足解説です。「書き方1:要点を冒頭に書く」と「ネットでの検索とその検索結果」の関係です。

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

人財教育

1.「〇〇とは」と検索する

何かを調べるときネットを使う方も多いと思います。そのとき「〇〇とは」と入力し検索する方もいると思います。例えば、2023年10月1日から導入される「インボイス制度」について調べたいとき「インボイス制度とは」と打ち込み検索することです。実際に「インボイス制度とは」と打ち込んで検索してみると、あるウェブサイトでは次のような説明が書いてあります。

 

インボイス制度とは、軽減税率により複数の税率ができたとき、仕入れ税額控除に適格請求書(インボイス)などの保存が要件となる制度です。』

 

このウェブサイトでは、「インボイス制度とは」という検索に対して、ウェブサイトの冒頭で、「インボイス制度とは・・・です」のように検索結果を簡潔に説明しています。つまり、ウェブサイトの冒頭で、インボイス制度の要点を簡潔に説明しています。また、「インボイス制度とは・・・です」という説明の後にインボイス制度について詳しく説明しています。

 

このウェブサイトは、「インボイス制度とは」という質問に対して内容が明確に伝わる解説をしています。

 

これは、「書き方1:要点を冒頭に書く」の書き方です。「書き方1:要点を冒頭に書く」とは、「内容に関する要点を冒頭に書き、この要点に関する説明をその後に書くこと」だからです。また、これは、「内容が明確に伝わる技術文書の書き方(その12)」で書いた以下の書き方と同じです。

 

【パターンⅡ】

1.〇〇交差点の改良計画の目的

〇〇交差点をスクランブル交差点に改良することが今回の〇〇交差点の改良計画の目的である。〇〇交差点では、歩行者や自転車と左折車との接触事故が毎年数件発生している。過去には歩行者の死亡事故も発生している。来年3月末には、〇〇交差点付近に大型ショッピングセンターができることから、〇〇交差点を利用する歩行者や自転車が増えると予想できる。そのため、歩行者や自転車の安全確保のため〇〇交差点を改良する。

 

ネットでの検索とその検索結果を読めば、「書き方1:要点を冒頭に書く」を使って技術文書を書くことで内容が明確に伝わることがわかります。

 

次回に続きます。

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
未来人材ビジョンで求められる起業家マインドを持ち据えた人物とは、

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,000件...

【目次】 国内最多のものづくりに関するセミナー掲載中! ものづくりドットコムでは、製造業に関するセミナーを常時2,000件...


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

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!   今回は、「ルール6:明確に伝わる文...


書くべきことを自分の頭の中ではっきりさせる

  1. 技術提案書を添削してわかったこと  先日、「技術提案書を書くときに重要なこと」をテーマに社員研修で講師を務めてきました。    国土...

  1. 技術提案書を添削してわかったこと  先日、「技術提案書を書くときに重要なこと」をテーマに社員研修で講師を務めてきました。    国土...


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

もっと見る
【SDGs取り組み事例】インクルージョンされた職場環境において、新しい価値を生み出し続ける ソニー・太陽株式会社(大分県速見郡日出町)

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...

1978年の設立以降、高品質なものづくりと障がい者雇用を続け、全社員のうち、障がいのある社員が約6割を占め、障がいの有無に関係なく誰もが生き生きと働く...


人的資源マネジメント:自分の「徳」を知って成果を出す(その1)

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...


製造業向けローコードの活用!次世代型MESで製造業DXによる変革を

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...

今カンファレンスで、ものづくり現場のDXを力強く推進する最新ソリューションのセッションが行われた中、特にものづくりドットコムが注目する株式会社TーPr...