【この連載の前回:“技術文書を書くこと”について考える(その3)へのリンク】
1.「技術文書を書くこと」についての整理
これまで、「技術文書を書くこと」を以下の視点で解説しました。
- ①技術文書=コミュニケーションの手段 (技術文書を書くこと:その1)
- ②技術文書を書く目的 (技術文書を書くこと:その2)
- ③「内容が伝わる」と「内容が“明確に”伝わる」の違い (技術文書を書くこと:その2)
- ④内容が明確に伝わる技術文書 (技術文書を書くこと:その2)
- ⑤内容が明確に伝わる技術文書を書く理由 (技術文書を書くこと:その3)
技術文書を書く目的は、「技術文書の書き手からその読み手に内容を伝達すること」です。「技術文書=コミュニケーションの手段」と考えると「内容が明確に伝わる技術文書」を書くことの重要性がわかります。
内容が明確に伝わる技術文書を書くうえでのポイントの一つは、書き手と読み手の違いを認識して読み手の立場に立って書くことです。これは重要な内容なので別途解説します。
2.内容を伝達する意識を持つ
「内容を伝達するために技術文書を書く」という意識で技術文書を書いてください。例えば、業務報告書を書くことを考えます。業務を行ったときには業務の最後にその報告書を書きます。このとき、「業務の成果をまとめる」あるいは「業務の成果を記録として残す」という意識で業務報告書を書くと思います。しかし、このような意識ではなく、「業務の成果(内容)を伝達するために業務報告書を書く」という意識で業務報告書を書いてください。
内容を伝達する意識を持つと技術文書を書く意識が変わります。例えば、「業務の成果(内容)を伝達するために業務報告書を書く」という意識を持つと業務報告書の書き方が変わります。「まとめる」あるいは「記録として残す」ではなく「業務の成果(内容)を伝達する」という意識に変わるからです。「業務の成果(内容)を伝達するためには業務報告書をどのように書いたらよいか」と考えます。
これは、他の技術文書、例えば、会議・打ち合わせの資料やメールを書くときも同じです。「技術文書=コミュニケーションの手段」と考えて「内容を...