「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方(その13)

今回は,「ネットで何かを調べたときのその説明」「書き方1:要点を冒頭に書く」の関係について解説します。

「〇〇とは」
何かを調べたいときに,「〇〇とは」とグーグルなどの検索エンジンに打ち込んで検索するも多いと思います。

例えば,2023年10月1日から導入される「インボイス制度」について調べたいときには「インボイス制度とは」と打ち込んで検索して調べることです。

実際に「インボイス制度とは」と打ち込んで検索してみると,例えば,あるウェブサイトでは以下のような説明が書いてあります。

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

「インボイス制度とは」という問いに対してその要点を簡潔に説明しています。このウェブサイトでは,この後にインボイス制度について詳しく説明しています。

これは,「書き方1:要点を冒頭に書く」の書き方です。書き方1とは,「内容に関する要点を冒頭に書き、この要点に関する説明をその後に書くこと」だからです。

これに対して,あるウェブサイトでは,「適格請求書(インボイス)とは」を説明したうえで,インボイス制度について「売手側」と「買手側」での必須事項について説明しています。

このウェブサイトでは,初めのウェブサイトのように「インボイス制度とは〇〇である」のようなインボイス制度に関する要点が書いてありません。すなわち,こちらがまず知りたいこと(インボイス制度の要点)が明確に書いてありません。このような説明を読むとストレスを感じます。

このように,「〇〇とは」と検索してもその問いに対する説明がわかりにくいウェブサイトもあります。このようなウェブサイトでの説明を読んでいるとストレスを感じます。

技術文書を書くときには,「書き方1:要点を冒頭に書く」を使って内容の要点(=読み手がまず知りたいこと)が明確にわかるように内容を書いてください。このように書いてあれば,読み手もストレスを感じずに技術文書を読むことができます。

次回に続きます。

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

test

この記事を読んだ方は、こちらも閲覧しています。

にほんブログ村 資格ブログ 工業・技術系資格へ にほんブログ村 資格ブログ 国家試験へ にほんブログ村 本ブログへ にほんブログ村 本ブログ 書評・レビューへ

ジェイタプコ代表・森谷仁の著書
マンガでわかる 技術文書の書き方:「伝わる」から「明確に伝わる」へ オーム社
2,640円 Amazonで購入する
技術文書の書き方として,「内容が明確に伝わる技術文書の書き方の技術」をマンガで解説した内容です。
「技術者のためのわかりやすい文書の書き方」オーム社
2,200円 Amazonで購入する
事例を示しながら17の書き方の使い方を解説しました。
「技術士第二次試験 建設部門 答案作成のテクニック 5つの手順で書いてみよう」オーム社
2,420円 Amazonで購入する
答案の書き方を学びたいと考えている受験生の必読書です。​
「技術士第二次試験 建設部門 完全突破」オーム社 水村俊幸共著
2,860円 Amazonで購入する
技術論文の書き方を、基本編と実践編に分けてわかりやすく解説しました。
企画&提案する技術士事務所 有限会社ジェイタプコ

ジェイタプコは「内容が明確に伝わる技術文書の書き方」をお伝えする会社です。

あらゆる分野・職種の技術者の方々に、研修やセミナーを通して「内容が明確に伝わる技術文書の書き方」をお伝えします。

トップへ戻る

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds

This will close in 0 seconds