OJTで気が付くこと内容が明確に伝わる技術文書の書き方（その41）

投稿日 2023-06-23

...

技術文書

2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方（その1）」の中で「内容が明確に伝わる技術文書を書くための４項目」として以下の４項目を書きました。この４項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

(1)重要なことを理解する
(2)書き方の技術を習得する
(3)必要なことを理解する
(4)日々のオンザジョブトレーニングを実践する

これらの４項目のうち「(4)日々のオンザジョブトレーニングを実践する」について解説を続けます。

【この連載の前回：内容が明確に伝わる技術文書の書き方（その４０）へのリンク】

１．日々のオンザジョブトレーニングとは

日々のオンザジョブトレーニングとは継続学習のことです。つまり、内容が明確に伝わる技術文書の書き方を学ぶためのトレーニングのことです。仕事を通してトレーニングをすることから日々のオンザジョブトレーニングです。具体的には、下記の「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。

技術文書

人財教育

今回は、日々のオンザジョブトレーニングで気が付くことを考えます。

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

日々のオンザジョブトレーニング^注1）で気が付くこととは、日々のオンザジョブトレーニングで「わかりにくい書き方（＝内容が明確に伝わらない書き方）」に気が付くようになることです。これに気が付くことで自己添削^注2）が成立します。自己添削をしてもわかりにくい書き方（＝内容が明確に伝わらない書き方）を見落としたら自己添削が成立しません。

^注1）：日々のオンザジョブトレーニングとは継続学習のことです。具体的には、前述の「内容が明に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。
^注2）：自己添削とは、技術文書を書いたらその内容が明確に伝わるかどうかを自分で添削することです。

わかりにくい書き方（＝内容が明確に伝わらない書き方）に気が付くためには「どのような書き方がわかりにくいのか」ということが判断できる基準が必要です。この基準になるのが、前述の「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」です。また、この基準があれば、わかりにくい書き方（＝内容が明確に伝わらない書き方）をわかりやすい書き方（＝内容が明確に伝わる書き方）に修正できます。