技術文書の品質管理(その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)

      1.コストダウンの中心は、設計にある  企業が存続していくためには、利益の獲得が必須です。もし、利益の確保ができなければ、企業の財産が減っていくとともに...

      1.コストダウンの中心は、設計にある  企業が存続していくためには、利益の獲得が必須です。もし、利益の確保ができなければ、企業の財産が減っていくとともに...


      1枚の基本設計構想図法 【快年童子の豆鉄砲】(その48)

        ◆1枚の基本設計構想図法 1.商品化プロセス これ以降は「夢商品開発七つ道具」の残り6つの説明になるのですが、この6つは「プロシュ...

        ◆1枚の基本設計構想図法 1.商品化プロセス これ以降は「夢商品開発七つ道具」の残り6つの説明になるのですが、この6つは「プロシュ...


      IPランドスケープとは~技術企業の高収益化:実践的な技術戦略の立て方(その11)

          ◆ IPランドスケープで何か見えると思っていないか?  「当社でも遅ればせながらIPランドスケープ、らしきものを始めたん...

          ◆ IPランドスケープで何か見えると思っていないか?  「当社でも遅ればせながらIPランドスケープ、らしきものを始めたん...


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

      もっと見る
      イノベーション戦略のキーツールとは

        1. 現代のワークショップ    ワークショップは元々、職人が集まって共同で何かを作るための「工房」「作業場」といった意味の...

        1. 現代のワークショップ    ワークショップは元々、職人が集まって共同で何かを作るための「工房」「作業場」といった意味の...


      進捗の可視化は必要最小限にするのがポイント(その1)

        1. メトリクスによる進捗管理サイクル    進捗管理とは、作成した計画にもとづいて現在の状況を把握することと、計画と実績に...

        1. メトリクスによる進捗管理サイクル    進捗管理とは、作成した計画にもとづいて現在の状況を把握することと、計画と実績に...


      進捗の見える化:第2回 プロジェクト管理の仕組み (その11)

       進捗の見える化ですが、前回のその10に続いて解説します。今回考えるべきポイントは、可視化・見える化の方法です。図40 に示しているように、進捗管理では予...

       進捗の見える化ですが、前回のその10に続いて解説します。今回考えるべきポイントは、可視化・見える化の方法です。図40 に示しているように、進捗管理では予...