技術文書の品質管理（その３）技術文書の品質管理に必要なこと

投稿日 2024-02-20

【目次】

今回は「技術文書の品質管理に必要なこと」について「内容が明確に伝わる技術文書の書き方」の考え方に基づき解説します。

1. 技術文書の品質管理に必要なこと

品質管理の目的とは、常に一定以上の品質を保ち、不良品を出さないようにすることです。品質管理とは、材料管理、工程管理、品質検査などです。技術文書の品質管理でもこれらのことを考える必要があります。品質の悪い技術文書（内容が明確に伝わらない技術文書）を書かないようにするためです。

そこで、技術文書の品質管理に必要なこととして、技術文書の品質管理での材料管理、工程管理、品質検査および品質管理上重要なことについて解説します。

2. 技術文書の材料管理

技術文書を書くときの材料とは、書き手が読み手に伝える内容のことです。例えば、メールの内容、会議の資料の内容あるいは報告書の内容などです。技術文書を書くときの材料管理とは、「内容を明確に理解していること」と「書き手の頭の中を整理すること」です。

内容が明確に伝わる技術文書を書くためには、工程管理と品質検査とともにこの材料管理も重要です。

「内容を明確に理解していること」と「書き手の頭の中を整理すること」については、「内容が明確に伝わる技術文書の書き方（その30）～（その35）」の記事の中で詳しく解説しました。

3. 技術文書の工程管理

技術文書を書くときの工程管理とは、内容が明確に伝わる技術文書を書くための管理のことです。つまり、「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」を使って技術文書を書くことです。

「技術文書を書く目的」や「『内容が伝わる』と「『内容が“明確に”伝わる』の違いを認識する」などを理解していることで、「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」を使って品質の良い技術文書（内容が明確に伝わる技術文書）を書くことができます。

技術文書の品質管理（その３）技術文書の品質管理に必要なこと

4. 技術文書の品質検査

技術文書を書くときの品質検査とは、書いた技術文書を確認することです。これについては、「技術文書の品質管理（その１）^注1）と（その２）^注2）」で解説しました。

不良品（内容が明確に伝わらない技術文書）を、例えば、クライアントに渡してしまうとクライアントの貴重な仕事の時間を奪うことになるかもしれません注3）。あるいは、自分の仕事の時間を無駄に使うことがあるかもしれません^注3）。

^注1）：「技術文書の品質管理（その１）文書の内容が明確に伝わるかどうかを確認」を参照
^注2）：「技術文書の品質管理（その２）技術文書を確認する人の視点から」を参照
^注3）：「内容が伝わり難い技術文書を書くことで起こる重大なこと」を参照

5. 技術文書の品質管理上重要なこと

技術文書を書くときの品質管理上重要なこととは、工程管理と品質検査を確実に行うことです。これらを確実に行うためのポイントは日々のオンザジョブトレーニング^注4）です。

日々のオンザジョブトレーニングで「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」を習得すれば工程管理を確実に行うことができます。また、日々のオンザジョブトレーニングで「内容が明確に伝わらない書き方の基準を持つこと^注1）」と「内容が明確に伝わらない書き方の修正方法がわかること...

技術文書の品質管理（その３）技術文書の品質管理に必要なこと

【目次】

今回は「技術文書の品質管理に必要なこと」について「内容が明確に伝わる技術文書の書き方」の考え方に基づき解説します。