“技術文書を書くこと”について考える(その4)

投稿日

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その3)へのリンク】 

1.「技術文書を書くこと」についての整理

これまで、「技術文書を書くこと」を以下の視点で解説しました。

  • ①技術文書=コミュニケーションの手段 (技術文書を書くこと:その1)
  • ②技術文書を書く目的 (技術文書を書くこと:その2)
  • ③「内容が伝わる」と「内容が“明確に”伝わる」の違い (技術文書を書くこと:その2)
  • ④内容が明確に伝わる技術文書 (技術文書を書くこと:その2)
  • ⑤内容が明確に伝わる技術文書を書く理由 (技術文書を書くこと:その3)

技術文書を書く目的は、「技術文書の書き手からその読み手に内容を伝達すること」です。「技術文書=コミュニケーションの手段」と考えると「内容が明確に伝わる技術文書」を書くことの重要性がわかります。

 

内容が明確に伝わる技術文書を書くうえでのポイントの一つは、書き手と読み手の違いを認識して読み手の立場に立って書くことです。これは重要な内容なので別途解説します。

 

2.内容を伝達する意識を持つ

「内容を伝達するために技術文書を書く」という意識で技術文書を書いてください。例えば、業務報告書を書くことを考えます。業務を行ったときには業務の最後にその報告書を書きます。このとき、「業務の成果をまとめる」あるいは「業務の成果を記録として残す」という意識で業務報告書を書くと思います。しかし、このような意識ではなく、「業務の成果(内容)を伝達するために業務報告書を書く」という意識で業務報告書を書いてください。

 

内容を伝達する意識を持つと技術文書を書く意識が変わります。例えば、「業務の成果(内容)を伝達するために業務報告書を書く」という意識を持つと業務報告書の書き方が変わります。「まとめる」あるいは「記録として残す」ではなく「業務の成果(内容)を伝達する」という意識に変わるからです。「業務の成果(内容)を伝達するためには業務報告書をどのように書いたらよいか」と考えます。

 

これは、他の技術文書、例えば、会議・打ち合わせの資料やメールを書くときも同じです。「技術文書=コミュニケーションの手段」と考えて「内容を...

技術文書

 

【この連載の前回:“技術文書を書くこと”について考える(その3)へのリンク】 

1.「技術文書を書くこと」についての整理

これまで、「技術文書を書くこと」を以下の視点で解説しました。

  • ①技術文書=コミュニケーションの手段 (技術文書を書くこと:その1)
  • ②技術文書を書く目的 (技術文書を書くこと:その2)
  • ③「内容が伝わる」と「内容が“明確に”伝わる」の違い (技術文書を書くこと:その2)
  • ④内容が明確に伝わる技術文書 (技術文書を書くこと:その2)
  • ⑤内容が明確に伝わる技術文書を書く理由 (技術文書を書くこと:その3)

技術文書を書く目的は、「技術文書の書き手からその読み手に内容を伝達すること」です。「技術文書=コミュニケーションの手段」と考えると「内容が明確に伝わる技術文書」を書くことの重要性がわかります。

 

内容が明確に伝わる技術文書を書くうえでのポイントの一つは、書き手と読み手の違いを認識して読み手の立場に立って書くことです。これは重要な内容なので別途解説します。

 

2.内容を伝達する意識を持つ

「内容を伝達するために技術文書を書く」という意識で技術文書を書いてください。例えば、業務報告書を書くことを考えます。業務を行ったときには業務の最後にその報告書を書きます。このとき、「業務の成果をまとめる」あるいは「業務の成果を記録として残す」という意識で業務報告書を書くと思います。しかし、このような意識ではなく、「業務の成果(内容)を伝達するために業務報告書を書く」という意識で業務報告書を書いてください。

 

内容を伝達する意識を持つと技術文書を書く意識が変わります。例えば、「業務の成果(内容)を伝達するために業務報告書を書く」という意識を持つと業務報告書の書き方が変わります。「まとめる」あるいは「記録として残す」ではなく「業務の成果(内容)を伝達する」という意識に変わるからです。「業務の成果(内容)を伝達するためには業務報告書をどのように書いたらよいか」と考えます。

 

これは、他の技術文書、例えば、会議・打ち合わせの資料やメールを書くときも同じです。「技術文書=コミュニケーションの手段」と考えて「内容を伝達する」という意識で技術文書を書いてください。

 

次回から、「内容が明確に伝わる技術文書の書き方」について解説します。

 

【参考文献】

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

 

関連解説記事「書くべきことを自分の頭の中ではっきりさせる」 

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
常に書けるようになるために 内容が明確に伝わる技術文書の書き方(その43)

  今回は「内容が明確に伝わる技術文書の書き方(その42)」の続きの内容です。 【この連載の前回:内容が明確に伝わる技術文書の書き方(そ...

  今回は「内容が明確に伝わる技術文書の書き方(その42)」の続きの内容です。 【この連載の前回:内容が明確に伝わる技術文書の書き方(そ...


学びたい!と思わせる話し方とは、リスキリングを促すノウハウ

  【目次】 今回は、研修を開催するときに、私が使っている話術についておはなしします。受講生の「学びのモチベーション」を...

  【目次】 今回は、研修を開催するときに、私が使っている話術についておはなしします。受講生の「学びのモチベーション」を...


新人教育の新しい潮流とは、学生時代と大きく異なる社会人の学び方

  新人の輝く学びを支援し、チーム力を加速する秘訣!今回は、新人指導の新しい潮流についてのおはなしです。 【目次】 1...

  新人の輝く学びを支援し、チーム力を加速する秘訣!今回は、新人指導の新しい潮流についてのおはなしです。 【目次】 1...


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

もっと見る
人財教育・人材育成、行動範囲が広いということは自分の裁量や権限で仕事ができること

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...

【目次】 1. 責任範囲と行動範囲、行動範囲が広いということは自分の裁量や権限で仕事ができること 多くの人が自分の手の届く範囲内の...


品質管理教育の重要ポイント

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...

 教えを請うなら実績のある人が好ましいと多くの人は思うでしょう。しかし実績のある人(成果を出している人)が必ずしも教え上手では無いと言うことがあります。今...


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

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

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