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

投稿日

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

 

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

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

もっと見る
メールで伝えたいことを100%伝える気配りとは

  メールによる情報伝達が発達し、対面式の会話機会が少なくなりました。しかし、 メールで伝えたことがなかなか伝わりにくいことも事実です。今...

  メールによる情報伝達が発達し、対面式の会話機会が少なくなりました。しかし、 メールで伝えたことがなかなか伝わりにくいことも事実です。今...


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

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

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


ライフキャリアの視点 技術者のキャリア整理法(その2)

 前回、技術者のキャリア整理法 (その1)自分自身のマーケティングについて述べました。今回は、(その2)ライフキャリアの視点です。人生には、楽しいこと、悲...

 前回、技術者のキャリア整理法 (その1)自分自身のマーケティングについて述べました。今回は、(その2)ライフキャリアの視点です。人生には、楽しいこと、悲...


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

もっと見る
自部門の数値把握:物流管理者の育て方(その2)

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...

  ◆ 自部門の数値把握 現場に入りがちな管理者はそれが管理者として当たり前の仕事、かつ褒められてしかるべき行為だと考えている節があります。もし管...


技術系リーダーとして身に付けておくべきスキルとは

        企業の成長のためには、従来の事業の延長線上に留まることなく、積極的に新製品や新規事業の創出、...

        企業の成長のためには、従来の事業の延長線上に留まることなく、積極的に新製品や新規事業の創出、...


【SDGs取組み事例】事業性質にとらわれず、“SDGsに貢献可能なものは何か”を皆で考える エスティーティー株式会社(神奈川県秦野市)

【目次】 国内製造業のSDGs取り組み事例一覧へ戻る 1. 従業員の意識改革や職場環境の整備などに取り組む エスティーティー株式...

【目次】 国内製造業のSDGs取り組み事例一覧へ戻る 1. 従業員の意識改革や職場環境の整備などに取り組む エスティーティー株式...