今回は、「5W1Hの考え方に基づく技術文書の品質管理」について解説します。
1. 5W1Hとは
5W1Hとは、「When(いつ)」「Where(どこで)」「Who(だれが)」「What(なにを)」「Why(なぜ)」「How(どのように)」の英単語の頭文字をとった言葉です。これらの要素にしたがって情報を伝えることで必要事項を相手にわかりやすくかつ明確に伝えることができます。
2. 技術文書の品質管理と5W1H
2.1 技術文書の品質管理をするうえでの5W1Hとは
技術文書の品質管理をするうえでの5W1Hとは「技術文書について『いつ、どこで、だれが、なにを、なぜ、どのように』品質管理をするのか」ということです。ここで、技術文書の品質管理とは、自分が書いた技術文書の内容が明確に伝わるかどうかを確認することです。
5W1Hに基づき技術文書の品質管理について考えると技術文書の品質管理のことが掘り下げて理解できます。
2.2 技術文書の品質管理での5W1Hについて
技術文書の品質管理での5W1Hとは以下のように考えることができます。
(1)When(いつ品質管理をするのか)
基本的に、技術文書を書き終えたときです。例えば、会議の資料やメールを書き終えたときです。技術文書を書いたら技術文書の品質管理を必ず行います。
(2)Where(どこで品質管理をするのか)
仕事をしている所です。
(3)Who(だれが品質管理をするのか)
技術文書を書いた書き手です。ただ、上司など書き手以外の人が技術文書の品質管理をすることもあります注1)。自分で品質管理をするうえで重要なことがあります注2)。それは以下の2点です。
- ①内容が明確に伝わらない書き方の基準を持つこと
- ②「内容が明確に伝わらない書き方」の修正方法がわかること
これらの条件を満たすことで品質管理を自分で確実に行うことができます。
注1):「技術文書の品質管理(その2)技術文書を確認する人の視点から」を参照
注2):「技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認」を参照
(4)What(なにに対して品質管理をするのか)
自分が書いた技術文書です。
(5)Why(なぜ品質管理をするのか)
不良品の技術文書(内容が明確に伝わらない技術文書)を書かないようにするためです。技術文書の品質管理を怠ると(内容が明確に伝わらない技術文書を書くと)読み手の貴重な仕事の時間を奪います。自分の仕事の時間を無駄に使うかもしれません注3)。仕事の関係者との技術文書を通したコミュニケーション不足で仕事が円滑に進まないことがあるかもしれません注4)。
注3):「内容が伝わり難い技術文書を書くことで起こる重大なこと」を参照
注4):「“技術文書を書くこと”について考える(その1)」を参照
(6)How(どのように品質管理をするのか)
書き手と読み手の違いを認識し読み手の立場で品質管理をします。書き手は知っている人、読み手は知らない人です注5)。すなわち、知らない人の立場に立って「自分が読み手だったらこの書き方で技術文書の内容が明確に伝わるか?」という視点で技術文書の品質管理をします。
注5):「内容が明確に伝わる技術文書の書き方(その3)」を参照
技術文書を書いたら読み手の立場に立って...