常に書けるようにする内容が明確に伝わる技術文書の書き方（その42）

投稿日 2023-07-03

技術文書

１．内容が明確に伝わる技術文書を書くための４項目

「内容が明確に伝わる技術文書の書き方（その1）」で次のことを書きました。

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

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

以下の４項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

①重要なことを理解する

「“技術文書を書くこと”について考える（その1 から 4 ）」で解説しました。

②書き方の技術を習得する

「内容が明確に伝わる技術文書の書き方（その2 から 29 ）」で解説しました。

③必要なことを理解する

「内容が明確に伝わる技術文書の書き方（その30 から 35 ）」で解説しました。

④日々のオンザジョブトレーニングを実践する

「内容が明確に伝わる技術文書の書き方（その36 から 41 ）」で解説しました。

この４項目をセットで学ぶことが、「内容が明確に伝わる技術文書の書き方」を学ぶ上での特徴です。

２．“常に”書けるようにする

セットの４項目とは、既述したように以下の内容です。

①重要なことを理解する
②書き方の技術を習得する
③必要なことを理解する
④日々のオンザジョブトレーニングを実践する

これら４項目は以下のような内容です。

「重要なことを理解する」とは、内容が明確に伝わる技術文書を書くとき“常に”認識すべきことです。
「書き方の技術を習得する」とは、内容が明確に伝わる技術文書を具体的に書くとき“常に”必要なことです。
「必要なことを理解する」とは、内容が明確に伝わる技術文書を書くため書き手の頭の中を“常に”整えることです。
「日々のオンザジョブトレーニングを実践する」とは、内容が明確に伝わる技術文書を“常に”書くために継続して実践すべきことです。

これらの内容を認識するうえで重要なキーワードは“常に”です。仕事上で書くあらゆる技術文書に対して、内容が明確に伝わる技術文書が書けるようにするため“常に”というキーワードが必要です。例えば、「業務や研究の報告書は内容が明確に伝わるように書けるが、メールでは書けない」ということがないようにするためです。

これらの４項目での“常に”を意識することで、「仕事上で書くあらゆる技術文書に対して“常に”内容が明確に伝わるように書こう」という意識になります。

これらの４項目はセットです。どれか一つでも欠けると内容が明確に伝わる技術文書を“常に”書くことはできません。セットで学ぶことが、内容が明確に伝わる技術文書を“常に”書くためのポイントです。

次回に続きます。

【参考文献】