技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認

投稿日

 
  技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認
【目次】

    1. 技術文書の品質管理とは

    製造業での品質管理とは「製品の品質に問題がないようにするための取り組み」のようなことです。技術文書の品質管理とは、自分が書いた技術文書の内容が明確に伝わるかどうかを確認することです。

     

    技術文書の品質管理には、自分で技術文書の品質管理をする場合(自分が書いた技術文書を自分で確認する)と自分以外の人が技術文書の品質管理をする場合(自分が書いた技術文書を自分以外の人が確認する)があります。今回は、自分で技術文書の品質管理をする場合について解説します。

     

    2. 自分で技術文書の品質管理をするポイント

    例えば、業務報告書やメールなどの技術文書を書いたときその内容を必ず確認します。すなわち、自分が書いた技術文書の品質管理を自分でします。自分で技術文書の品質管理をするうえでのポイントが2つあります。

     

    2.1 内容が伝わり難い、分かりにくい書き方とは

    内容が伝わり難い書き方(わかりにくい書き方)の基準を持つことが自分で技術文書の品質管理をするうえでの第1のポイントです。この基準がないと内容が明確に伝わらない書き方を見逃すからです。

     

    例えば「製品Aと製品Bの販売個数は、約10、000個/月である」と技術文書の中に書いてあっても「この文は問題ない」と判断したら、書き手は自分で書いた技術文書(文)の品質管理ができなかったということです。この文は内容が明確に伝わらないからです。

     

    日々のオンザジョブトレーニング注1)で、内容が明確に伝わらない書き方の基準を持つことができます。「内容が明確に伝わる技術文書の書き方の3原則注2)」と「6つのルールと18の書き方注3)」が、内容が明確に伝わらない書き方の基準になるからです。

    ちなみに、「製品Aと製品Bの販売個数は、約10、000個/月である」という文は、「6つのルールと18の書き方」の中の「書き方14:意味が明確な文を書く」に抵触します。

    技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認

     

    2.2「内容が明確に伝わらない書き方」の修正方法がわかることが第2のポイント

    「内容が明確に伝わらない書き方」の修正方法がわかることが自分で技術文書の品質管理をするうえでの第2のポイントです。例えば、文の羅列で書いてある箇所があったときこの修正方法がわかっていれば「かたまりに分けて書こう」「箇条書きで書こう」あるいは「表で書こう」などのような方法を使ってこの箇所が修正できます。

     

    日々のオンザジョブトレーニングで「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を習得すれば、内容が明確に伝わらない書き方の修正方法がわかります。

     

    3. 技術文書の品質管理を確実に自分で行う

    「内容が明確に伝わり難い技術文書を書くことで起こる重大なこと注4)」の記事の中で解説したように、内容が明確に伝わらない技術文書(わかりにくい技術文書)を書くことで「無駄な時間を使うこと(時間の無駄遣い)」が起きます。時間の無駄遣いをしないためにも技術文書の品質管理を確実に自分で行う...

     
      技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認
    【目次】

      1. 技術文書の品質管理とは

      製造業での品質管理とは「製品の品質に問題がないようにするための取り組み」のようなことです。技術文書の品質管理とは、自分が書いた技術文書の内容が明確に伝わるかどうかを確認することです。

       

      技術文書の品質管理には、自分で技術文書の品質管理をする場合(自分が書いた技術文書を自分で確認する)と自分以外の人が技術文書の品質管理をする場合(自分が書いた技術文書を自分以外の人が確認する)があります。今回は、自分で技術文書の品質管理をする場合について解説します。

       

      2. 自分で技術文書の品質管理をするポイント

      例えば、業務報告書やメールなどの技術文書を書いたときその内容を必ず確認します。すなわち、自分が書いた技術文書の品質管理を自分でします。自分で技術文書の品質管理をするうえでのポイントが2つあります。

       

      2.1 内容が伝わり難い、分かりにくい書き方とは

      内容が伝わり難い書き方(わかりにくい書き方)の基準を持つことが自分で技術文書の品質管理をするうえでの第1のポイントです。この基準がないと内容が明確に伝わらない書き方を見逃すからです。

       

      例えば「製品Aと製品Bの販売個数は、約10、000個/月である」と技術文書の中に書いてあっても「この文は問題ない」と判断したら、書き手は自分で書いた技術文書(文)の品質管理ができなかったということです。この文は内容が明確に伝わらないからです。

       

      日々のオンザジョブトレーニング注1)で、内容が明確に伝わらない書き方の基準を持つことができます。「内容が明確に伝わる技術文書の書き方の3原則注2)」と「6つのルールと18の書き方注3)」が、内容が明確に伝わらない書き方の基準になるからです。

      ちなみに、「製品Aと製品Bの販売個数は、約10、000個/月である」という文は、「6つのルールと18の書き方」の中の「書き方14:意味が明確な文を書く」に抵触します。

      技術文書の品質管理(その1)文書の内容が明確に伝わるかどうかを確認

       

      2.2「内容が明確に伝わらない書き方」の修正方法がわかることが第2のポイント

      「内容が明確に伝わらない書き方」の修正方法がわかることが自分で技術文書の品質管理をするうえでの第2のポイントです。例えば、文の羅列で書いてある箇所があったときこの修正方法がわかっていれば「かたまりに分けて書こう」「箇条書きで書こう」あるいは「表で書こう」などのような方法を使ってこの箇所が修正できます。

       

      日々のオンザジョブトレーニングで「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を習得すれば、内容が明確に伝わらない書き方の修正方法がわかります。

       

      3. 技術文書の品質管理を確実に自分で行う

      「内容が明確に伝わり難い技術文書を書くことで起こる重大なこと注4)」の記事の中で解説したように、内容が明確に伝わらない技術文書(わかりにくい技術文書)を書くことで「無駄な時間を使うこと(時間の無駄遣い)」が起きます。時間の無駄遣いをしないためにも技術文書の品質管理を確実に自分で行うことが必要です。

       

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

      ◆関連解説記事:実践!技術マネジメント:7つのプロセスと35のチェックポイント

       

      特集】技術士第二次試験対策:技術士第二次試験に関する記事まとめページはこちら!口頭試験や論文対策などのポイントについての記事を紹介しています。

       

       

         続きを読むには・・・


      この記事の著者

      森谷 仁

      「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!

      「君の書く文書は、わかりにくい」と言われる技術者から、「君の書く文書は、わかりやすい」と言われる技術者へのステップアップ!


      「技術マネジメント総合」の他のキーワード解説記事

      もっと見る
      真の「デザイン」は、「設計」の概念!

      1. デザイン重視の背景  例えば携帯電話の開発で、アップル、韓国LG電子、NEC、ソニーなどが、デザインを最優先する戦略をとり始めています。競合各社の...

      1. デザイン重視の背景  例えば携帯電話の開発で、アップル、韓国LG電子、NEC、ソニーなどが、デザインを最優先する戦略をとり始めています。競合各社の...


      『価値づくり』の研究開発マネジメント (その9)

          今回は、オープンイノベーションを経済学のキーワードから「比較優位の原則」を解説します。 ◆関連解説『技術マネジメントとは』 ...

          今回は、オープンイノベーションを経済学のキーワードから「比較優位の原則」を解説します。 ◆関連解説『技術マネジメントとは』 ...


      製品・技術開発力強化策【連載記事紹介】

        製品・技術開発力強化策の連載が無料でお読みいただけます!   ◆製品・技術開発力強化策 時代の流れに沿う開発テ-マとし...

        製品・技術開発力強化策の連載が無料でお読みいただけます!   ◆製品・技術開発力強化策 時代の流れに沿う開発テ-マとし...


      「技術マネジメント総合」の活用事例

      もっと見る
      擦り合わせ型と組み合わせ型、目指すべき開発体制とは(その2)

      【目指すべき開発体制 連載目次】 目指すべき開発体制とは(その1)擦り合わせ型と組み合わせ型 目指すべき開発体制とは(その2)日本企業文化を引きず...

      【目指すべき開発体制 連載目次】 目指すべき開発体制とは(その1)擦り合わせ型と組み合わせ型 目指すべき開発体制とは(その2)日本企業文化を引きず...


      R&Dの価値創造力を高めるシンプルツール、iMapとは、

       技術経営とは、「企業の経営資源である技術を経営戦略の中核に位置づけ、顧客価値の創造へ向けて、その獲得・強化・活用を戦略的に行うことにより、継続的な企業の...

       技術経営とは、「企業の経営資源である技術を経営戦略の中核に位置づけ、顧客価値の創造へ向けて、その獲得・強化・活用を戦略的に行うことにより、継続的な企業の...


      仕組みの見直しに成功する組織1 プロジェクト管理の仕組み (その25)

       この連載では、仕組みの見直しをテーマに様々な考え方や事例を紹介しているわけですが、実際にコンサルタントして仕組みの見直しに取り組んだ組織の中には成功して...

       この連載では、仕組みの見直しをテーマに様々な考え方や事例を紹介しているわけですが、実際にコンサルタントして仕組みの見直しに取り組んだ組織の中には成功して...