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

「6つのルールと18の書き方」の具体的な使い方の解説の続きです。今回も,書き方の使い方の一例を解説します。

=

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

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

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

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

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

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

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

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

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

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

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

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

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

次回に続きます。

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

トップへ戻る

This will close in 20 seconds

This will close in 20 seconds