日々のオンザジョブトレーニングで気が付くこと

今回は,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その46)」です。「日々のオンザジョブトレーニングで気が付くこと」について解説します。

■日々のオンザジョブトレーニングで気が付くこと
日々のオンザジョブトレーニングで気が付くこととは,日々のオンザジョブトレーニングで「わかりにくい書き方(=内容が明確に伝わらない書き方)」に気が付くようになることです。これに気が付くことで自己添削注1)が成立します。自己添削をしてもわかりにくい書き方(=内容が明確に伝わらない書き方)を見落としたら自己添削が成立しません
注1):自己添削とは,技術文書を書いたらその内容が明確に伝わるかどうかを自分で添削することです。「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その44)」参照のこと

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くためには,「どのような書き方がわかりにくいのか」が判断できる基準が必要です。この判断基準になるのが,「内容が明確に伝わる技術文書の書き方の3原則」「6つのルールと18の書き方」です。

また,この判断基準があれば,わかりにくい書き方(=内容が明確に伝わらない書き方)をわかりやすい書き方(=内容が明確に伝わる書き方)に修正できます。

■「気が付くおよび修正できる」とは
わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くこと,これをわかりやすい書き方(=内容が明確に伝わる書き方)に修正できることとは,例えば,以下のようなことです。

◆構成がない。
⇒「内容が明確に伝わる技術文書の書き方の3原則の中の第2原則:内容が明確に伝わる構成を考える」で修正しよう。

◆内容の要点が書いてない。
⇒「書き方1:要点を冒頭に書く」で修正しよう。

◆根拠が書いてない。
⇒「書き方4:根拠を書く」で修正しよう。

◆文の羅列で書いてある
⇒「書き方6:かたまりに分けて書く」で修正しよう。

◆具体的な文で書いてない。
⇒「書き方13:具体的な文を書く」で修正しよう。

日々のオンザジョブトレーニングで「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を習得することで,「どのような書き方がわかりにくいのか」ということが判断できる基準ができます。また,わかりにくい書き方(=内容が明確に伝わらない書き方)の修正方法がわかります。

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くようになることも日々のオンザジョブトレーニングの特徴の一つです。

次回に続きます。

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

トップへ戻る

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

This will close in 0 seconds