常に書けるようにする 内容が明確に伝わる技術文書の書き方(その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日
◆【特集】 連載記事紹介:連載記事のタイトルをまとめて紹介、各タイトルから詳細解説に直リンク!!

 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
相手が自ら動く、たった1行の魔法の言葉(中級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その5)

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...

         【あなたも一瞬で「技術が伝わる」エンジニアになれる 連載目次】 1. 会話を...


具体的な内容の文を書くには

1. 内容が頭の中に浮かんでくる文を書く  今回の記事は、2018年3月28日に掲載した記事(テーマ:“ぼんやりとした内容の文を書く”から“はっ...

1. 内容が頭の中に浮かんでくる文を書く  今回の記事は、2018年3月28日に掲載した記事(テーマ:“ぼんやりとした内容の文を書く”から“はっ...


成果主義のメリットとメンタルヘルス

 事務職や専門職など「ホワイトカラー」を対象に、週40時間といった労働時間規制の適用を外し、成果に見合った給与を支払う「ホワイトカラー・エグゼンプション」...

 事務職や専門職など「ホワイトカラー」を対象に、週40時間といった労働時間規制の適用を外し、成果に見合った給与を支払う「ホワイトカラー・エグゼンプション」...


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

もっと見る
中国のクリーン化担当女性の事例

 私が足繁く通っていた、中国の工場の女性クリーン化担当の話です。その工場は上海から車で2時間ほどのところにあり、約1万人の社員を抱えていました。その女性は...

 私が足繁く通っていた、中国の工場の女性クリーン化担当の話です。その工場は上海から車で2時間ほどのところにあり、約1万人の社員を抱えていました。その女性は...


人財教育・人材育成、 理由のないルール、あなたの感情を他人はわからない

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

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


人財教育・人材育成、ただ頑張るだけでは仕事ではありません。結果を意識した行動が取れますか?

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

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