OJTで気が付くこと 内容が明確に伝わる技術文書の書き方(その41)

投稿日

技術文書

 

2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」として以下の4項目を書きました。この4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

  • (1)重要なことを理解する
  • (2)書き方の技術を習得する
  • (3)必要なことを理解する
  • (4)日々のオンザジョブトレーニングを実践する

 

これらの4項目のうち「(4)日々のオンザジョブトレーニングを実践する」について解説を続けます。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その40)へのリンク】 

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

日々のオンザジョブトレーニングとは継続学習のことです。つまり、内容が明確に伝わる技術文書の書き方を学ぶためのトレーニングのことです。仕事を通してトレーニングをすることから日々のオンザジョブトレーニングです。具体的には、下記の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。

 

技術文書

 

人財教育

 

今回は、日々のオンザジョブトレーニングで気が付くことを考えます。

 

2.日々のオンザジョブトレーニングで気が付くこと

日々のオンザジョブトレーニング注1)で気が付くこととは、日々のオンザジョブトレーニングで「わかりにくい書き方(=内容が明確に伝わらない書き方)」に気が付くようになることです。これに気が付くことで自己添削注2)が成立します。自己添削をしてもわかりにくい書き方(=内容が明確に伝わらない書き方)を見落としたら自己添削が成立しません。

注1):日々のオンザジョブトレーニングとは継続学習のことです。具体的には、前述の「内容が明に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。
注2):自己添削とは、技術文書を書いたらその内容が明確に伝わるかどうかを自分で添削することです。

 

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くためには「どのような書き方がわかりにくいのか」ということが判断できる基準が必要です。この基準になるのが、前述の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。また、この基準があれば、わかりにくい書き方(=内容が明確に伝わらない書き方)をわかりやすい書き方(=内容が明確に伝わる書き方)に修正できます。

 

3.「気が付くおよび修正できる」とは

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くこと、これをわかりやすい書き方(=内容が明確に伝わる書き方)に修正できることとは、例えば、以下のようなことです。

 

  1. 構成がない。
    ➡「内容が明確に伝わる技術文書の書き方の3原則の中の第2原則:内容が明確に伝わる構成を考える」で修正しよう。
  2. 内容の要点が書いてない。
    ➡「書き方1:要点を冒頭に書く」で修正しよう。
  3. 根拠が書いてない。
    ➡「書き方4:根拠を書く」で修正しよう。
  4. 文の羅列で書いてある。
    ➡「書き方6:かたまりに分けて書く」で修正しよう。
  5. 具体的な文で書いてない。
    ➡「書き方13:具体的な文を書く」で修正しよう。

 

日々のオンザジョブトレーニングで前述の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を習得することで、「どのような書き...

技術文書

 

2022年9月12日に掲載した「内容が明確に伝わる技術文書の書き方(その1)」の中で「内容が明確に伝わる技術文書を書くための4項目」として以下の4項目を書きました。この4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

  • (1)重要なことを理解する
  • (2)書き方の技術を習得する
  • (3)必要なことを理解する
  • (4)日々のオンザジョブトレーニングを実践する

 

これらの4項目のうち「(4)日々のオンザジョブトレーニングを実践する」について解説を続けます。

【この連載の前回:内容が明確に伝わる技術文書の書き方(その40)へのリンク】 

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

日々のオンザジョブトレーニングとは継続学習のことです。つまり、内容が明確に伝わる技術文書の書き方を学ぶためのトレーニングのことです。仕事を通してトレーニングをすることから日々のオンザジョブトレーニングです。具体的には、下記の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。

 

技術文書

 

人財教育

 

今回は、日々のオンザジョブトレーニングで気が付くことを考えます。

 

2.日々のオンザジョブトレーニングで気が付くこと

日々のオンザジョブトレーニング注1)で気が付くこととは、日々のオンザジョブトレーニングで「わかりにくい書き方(=内容が明確に伝わらない書き方)」に気が付くようになることです。これに気が付くことで自己添削注2)が成立します。自己添削をしてもわかりにくい書き方(=内容が明確に伝わらない書き方)を見落としたら自己添削が成立しません。

注1):日々のオンザジョブトレーニングとは継続学習のことです。具体的には、前述の「内容が明に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を使って様々な仕事に関する技術文書を書くことです。
注2):自己添削とは、技術文書を書いたらその内容が明確に伝わるかどうかを自分で添削することです。

 

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くためには「どのような書き方がわかりにくいのか」ということが判断できる基準が必要です。この基準になるのが、前述の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。また、この基準があれば、わかりにくい書き方(=内容が明確に伝わらない書き方)をわかりやすい書き方(=内容が明確に伝わる書き方)に修正できます。

 

3.「気が付くおよび修正できる」とは

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くこと、これをわかりやすい書き方(=内容が明確に伝わる書き方)に修正できることとは、例えば、以下のようなことです。

 

  1. 構成がない。
    ➡「内容が明確に伝わる技術文書の書き方の3原則の中の第2原則:内容が明確に伝わる構成を考える」で修正しよう。
  2. 内容の要点が書いてない。
    ➡「書き方1:要点を冒頭に書く」で修正しよう。
  3. 根拠が書いてない。
    ➡「書き方4:根拠を書く」で修正しよう。
  4. 文の羅列で書いてある。
    ➡「書き方6:かたまりに分けて書く」で修正しよう。
  5. 具体的な文で書いてない。
    ➡「書き方13:具体的な文を書く」で修正しよう。

 

日々のオンザジョブトレーニングで前述の「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」を習得することで、「どのような書き方がわかりにくいのか」ということが判断できる基準ができます。わかりにくい書き方(=内容が明確に伝わらない書き方)の修正方法がわかります。

 

わかりにくい書き方(=内容が明確に伝わらない書き方)に気が付くようになることも日々のオンザジョブトレーニングの特徴の一つです。

次回に続きます。

 

【参考文献】

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

 

◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!

 

関連解説記事「相手の立場に立って考える」こと 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


「人財教育・育成」の他のキーワード解説記事

もっと見る
読み手の立場に立って文書を書くとは

1. 読み手の立場に立って文書を書く  これまでに掲載した記事の中で以下のことを何度も書きました。    わかりやすい文書を書くうえで最も重要な...

1. 読み手の立場に立って文書を書く  これまでに掲載した記事の中で以下のことを何度も書きました。    わかりやすい文書を書くうえで最も重要な...


教育制度を見直す必要 教育研修の進め方(その1)

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....

【教育研修の進め方 連載目次】 1.  教育制度を見直す必要 2.  ジョブスキル教育 3.  階層別教育 4....


部下の成長を促す方法とは

  書籍を読んでいたら『仕事に満足していない人は7割もいる』と書いてあり、私は「えっ、本当に?」と驚きを隠せませんでした。人の心は、浮き沈...

  書籍を読んでいたら『仕事に満足していない人は7割もいる』と書いてあり、私は「えっ、本当に?」と驚きを隠せませんでした。人の心は、浮き沈...


「人財教育・育成」の活用事例

もっと見る
人的資源マネジメント:自分の「徳」を知って成果を出す(その1)

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...

 「徳」という単語は高い人間性を表現するときに使われます。たとえば、「徳がある人」「徳を高める」「徳を積む」というような使い方をします。「徳」というのは道...


人財教育・人材育成、正しいこと、正しいことにとらわれ過ぎないことも大事

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...

【目次】 ▼さらに深く学ぶなら!「行動科学」に関するセミナーはこちら! ▼さらに幅広く学ぶなら!「分野別のカリキュラム」に関するオ...


‐能力開発のシステム創り 製品・技術開発力強化策の事例(その44)

●能力開発のシステム化に必要不可欠の条件。   前回の事例その43に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確にす...

●能力開発のシステム化に必要不可欠の条件。   前回の事例その43に続いて解説します。    (1) 情報伝達の仕組み創り   (2) 目標を明確にす...