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

投稿日

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

技術文書

 

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

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

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

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

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

 

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

 

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

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

 

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

 

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

 

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

 

【参考文献】

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

 

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

 

   続きを読むには・・・


この記事の著者

森谷 仁

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

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


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

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

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

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


相手をひきつける「話し方」とは

  研修やwebセミナーを受けていて「”ひきつけられる”様な感じで、時間も短く感じた。」という経験はありませんか?...

  研修やwebセミナーを受けていて「”ひきつけられる”様な感じで、時間も短く感じた。」という経験はありませんか?...


「やりがい」のある仕事とは

  1. やりがい のある仕事 『 やりがい のある仕事』ができている人って、きっとその瞬間、楽しくてイキイキと過ごしているのでしょうね...

  1. やりがい のある仕事 『 やりがい のある仕事』ができている人って、きっとその瞬間、楽しくてイキイキと過ごしているのでしょうね...


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

もっと見る
「話し方」で解決!職場で仕事を押し付けられていたMさんの実例

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...

  1. 仕事を押し付けられて残業続き  Mさんは技術系の会社に勤める元気のいい女性です。一見、話し方に問題はなさそうに見えるのですが、...


コンプライアンス意識を持とう:職場のマネジメント

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...

  ◆ 物流監督者の心掛け  今回は、物流監督者が職場をマネジメントする際に取るべき態度や行動についてお話します。なぜなら、その態度や行...


人財教育・人材育成、勝ち負け思考とは?無意識に自分と相手を比較

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

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