常に書けるようにする 内容が明確に伝わる技術文書の書き方(その42)

投稿日

技術文書

 

1.内容が明確に伝わる技術文書を書くための4項目

内容が明確に伝わる技術文書の書き方(その1)」で次のことを書きました。

 

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

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

 

以下の4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

①重要なことを理解する

「“技術文書を書くこと”について考える( その1 から 4 )」で解説しました。

 

②書き方の技術を習得する

「内容が明確に伝わる技術文書の書き方( その2 から 29 )」で解説しました。

 

③必要なことを理解する

「内容が明確に伝わる技術文書の書き方( その30 から 35 )」で解説しました。

 

④日々のオンザジョブトレーニングを実践する

「内容が明確に伝わる技術文書の書き方( その36 から 41 )」で解説しました。

 

この4項目をセットで学ぶことが、「内容が明確に伝わる技術文書の書き方」を学ぶ上での特徴です。

 

2.“常に”書けるようにする

セットの4項目とは、既述したように以下の内容です。

  • ①重要なことを理解する
  • ②書き方の技術を習得する
  • ③必要なことを理解する
  • ④日々のオンザジョブトレーニングを実践する

これら4項目は以下のような内容です。

  • 「重要なことを理解する」とは、内容が明確に伝わる技術文書を書くとき“常に”認識すべきことです。
  • 「書き方の技術を習得する」とは、内容が明確に伝わる技術文書を具体的に書くとき“常に”必要なことです。
  • 「必要なことを理解する」とは、内容が明確に伝わる技術文書を書くため書き手の頭の中を“常に”整えることです。
  • 「日々のオンザジョブトレーニングを実践する」とは、内容が明確に伝わる技術文書を“常に”書くために継続して実践すべきことです。

 

これらの内容を認識するうえで重要なキーワードは“常に”です。仕事上で書くあらゆる技術文書に対して、内容が明確に伝わる技術文書が書けるようにするため“常に”というキーワードが必要です。例えば、「業務や研究の報告書は内容が明確に伝わるように書けるが、メールでは書けない」ということがないようにするためです。

 

これらの4項目での“常に”を意識することで、「仕事上で書くあらゆる技術文書に対して“常に”内容が明確に伝わるように書こう」という意識になります。

 

これらの4項目はセットです。どれか一つでも欠けると内容が明確に伝わる技術文書を“常に”書くことはできません。セットで学ぶことが、内容が明確に伝わる技術文書を“常に”書くためのポイントです。

次回に続きます。

 

【参考文献】

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

技術文書

 

1.内容が明確に伝わる技術文書を書くための4項目

内容が明確に伝わる技術文書の書き方(その1)」で次のことを書きました。

 

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

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

 

以下の4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。

①重要なことを理解する

「“技術文書を書くこと”について考える( その1 から 4 )」で解説しました。

 

②書き方の技術を習得する

「内容が明確に伝わる技術文書の書き方( その2 から 29 )」で解説しました。

 

③必要なことを理解する

「内容が明確に伝わる技術文書の書き方( その30 から 35 )」で解説しました。

 

④日々のオンザジョブトレーニングを実践する

「内容が明確に伝わる技術文書の書き方( その36 から 41 )」で解説しました。

 

この4項目をセットで学ぶことが、「内容が明確に伝わる技術文書の書き方」を学ぶ上での特徴です。

 

2.“常に”書けるようにする

セットの4項目とは、既述したように以下の内容です。

  • ①重要なことを理解する
  • ②書き方の技術を習得する
  • ③必要なことを理解する
  • ④日々のオンザジョブトレーニングを実践する

これら4項目は以下のような内容です。

  • 「重要なことを理解する」とは、内容が明確に伝わる技術文書を書くとき“常に”認識すべきことです。
  • 「書き方の技術を習得する」とは、内容が明確に伝わる技術文書を具体的に書くとき“常に”必要なことです。
  • 「必要なことを理解する」とは、内容が明確に伝わる技術文書を書くため書き手の頭の中を“常に”整えることです。
  • 「日々のオンザジョブトレーニングを実践する」とは、内容が明確に伝わる技術文書を“常に”書くために継続して実践すべきことです。

 

これらの内容を認識するうえで重要なキーワードは“常に”です。仕事上で書くあらゆる技術文書に対して、内容が明確に伝わる技術文書が書けるようにするため“常に”というキーワードが必要です。例えば、「業務や研究の報告書は内容が明確に伝わるように書けるが、メールでは書けない」ということがないようにするためです。

 

これらの4項目での“常に”を意識することで、「仕事上で書くあらゆる技術文書に対して“常に”内容が明確に伝わるように書こう」という意識になります。

 

これらの4項目はセットです。どれか一つでも欠けると内容が明確に伝わる技術文書を“常に”書くことはできません。セットで学ぶことが、内容が明確に伝わる技術文書を“常に”書くためのポイントです。

次回に続きます。

 

【参考文献】

  • 森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!

 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
人財育成(その11) クリーン化について(その106)

  毎年、5月をむかえると新入社員が入社して1ヶ月が経ちます。現在社員教育中のところもあれば、現場で即戦力として働いている場合もあるでしょ...

  毎年、5月をむかえると新入社員が入社して1ヶ月が経ちます。現在社員教育中のところもあれば、現場で即戦力として働いている場合もあるでしょ...


ポジティブ心理学 【連載記事紹介】

  ポジティブ心理学の連載記事が無料でお読みいただけます!   ◆イキイキとした生産性の高い組織をつくる!ポジティブ心理学 「ポジテ...

  ポジティブ心理学の連載記事が無料でお読みいただけます!   ◆イキイキとした生産性の高い組織をつくる!ポジティブ心理学 「ポジテ...


成長できる技術者の報告書の書き方、技術的評価だけでなく、必ず経済的評価を記述する

1. 技術者が成長するためには  技術者の成長を後押しできるのが技術論文や技術報告書です。例えば、コンサルタントは、クライアントをいかに納得させ報酬を得...

1. 技術者が成長するためには  技術者の成長を後押しできるのが技術論文や技術報告書です。例えば、コンサルタントは、クライアントをいかに納得させ報酬を得...


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

もっと見る
QFD(品質機能展開)で人財開発施策を俯瞰

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...

 QFD(Quality Function Deployment:品質機能展開)は、横軸にお客様の声を、縦軸に技術特性を記述したものです。しかし技術分野だ...


人を誉める時は順番を考えよ -クリーン化診断の例を添えて-

 前回は人を誉める時のタイミングについてでした。今回はその順番についてお話します。 1.誉める順番を考える  現場に行って、「あれがいけない、これがい...

 前回は人を誉める時のタイミングについてでした。今回はその順番についてお話します。 1.誉める順番を考える  現場に行って、「あれがいけない、これがい...


人財教育・人材育成、仕事の影響力を高め、仕事の満足度を高めるには

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 継続的に成果を出して仕事の影響力を高める 仕...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 継続的に成果を出して仕事の影響力を高める 仕...