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

投稿日 2022-11-22

...

技術文書

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

人財教育

１．「〇〇とは」と検索する

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

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

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

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

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

【パターンⅡ】

１．〇〇交差点の改良計画の目的

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

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

次回に続きます。

【参考文献】

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

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

◆関連解説『人財教育とは』

　続きを読むには・・・

新規会員登録