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

投稿日

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

 

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

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
「話題や相手の気持ちを考えなくても」喜ばれる会話ができる!(初級編) あなたも一瞬で「技術が伝わる」エンジニアになれる(その3)

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


人財育成(その12) クリーン化について(その107)

  会社組織の中では、“報告は結論から”と良く言われます。また、そのように指導される場合が多いでしょう。これは単純...

  会社組織の中では、“報告は結論から”と良く言われます。また、そのように指導される場合が多いでしょう。これは単純...


改善活動のモチベーションを高めるリーダーの説明力と説得力とは

【目次】 「うちの会社では、ISO9001に基づいた目的・目標の運用管理制度が整っているにも関わらず、なぜ面白い発想が出てこないので...

【目次】 「うちの会社では、ISO9001に基づいた目的・目標の運用管理制度が整っているにも関わらず、なぜ面白い発想が出てこないので...


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

もっと見る
【SDGs取り組み事例】ダイバーシティ経営で人的資源を最適化 有限会社川田製作所

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...

「誰一人残さない」…社員のニーズや得手不得手を把握、自社を活性化 【目次】   国内製造業のSDGs取り...


仕事とは、仕事の準備、仕事の重点、仕事の継続

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 仕事とは、仕事の準備 仕事に限らず何事にも準...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. 仕事とは、仕事の準備 仕事に限らず何事にも準...


人財教育・人材育成、こだわりと責任範囲

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...

【目次】 ▼さらに深く学ぶなら!「ビジネススキル」に関するセミナーはこちら! 1. こだわり「別の方法がある」と考えることも大事 ...