...
内容が明確に伝わる技術文書の書き方（その１）
更新日 2022-12-21
投稿日 2022-09-12
【この連載の前回：“技術文書を書くこと”について考える（その４）へのリンク】
今回から、「内容が明確に伝わる技術文書」の書き方について解説します。
１．内容が明確に伝わる技術文書を書くための４項目
以下の４項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。
- (1)重要なことを理解する
- (2)書き方の技術を習得する
- (3)必要なことを理解する
- (4)日々のオンザジョブトレーニングを実践する
（１）重要なことを理解する
これは、内容が明確に伝わる技術文書を書くうえで重要なことを理解することです。重要なこととは、「技術文書を書く目的」や「“伝わる”と“明確に伝わる”の違い」などです。これらを理解することで、内容が明確に伝わる技術文書を書く必要性がわかります。これまでの４回で解説したことは「重要なことを理解する」に関する内容です。
（２）書き方の技術を習得する
これは、「内容が明確に伝わる技術文書の書き方の技術」を習得することです。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の３原則」と「６つのルールと18の書き方」です。これらは、内容が明確に伝わる技術文書の書き方の中心となる内容です。
（３）必要なことを理解する
これは、内容が明確に伝わる技術文書を書くうえで必要なことを理解することです。必要なこととは、「伝える内容を明確に理解していること」と「頭の中を整理すること」です。これらを理解することで、書き手が、伝える内容を理解しかつ整理できていることの重要性がわかります。
（４）日々のオンザジョブトレーニングを実践する
これは、継続学習（日々のオンザジョブトレーニング）をすることです。日々のオンザジョブトレーニングの実践で、内容が明確に伝わる技術文書の書き方が習得できます。また、書き方がレベルアップします。「継続は力なり」です。
内容が明確に伝わる技術文書を書くための４項目のうち、「重要なことを理解する」についてはこれまで４回にわたり解説しました。次回から「書き方の技術を習得する」、「必要なことを理解する」および「日々のオンザジョブトレーニングを実践する」について解説します。
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆関連解説記事「書くべきことを自分の頭の中ではっきりさせる」
続きを読むには・・・
「人財教育・育成」の他のキーワード解説記事
もっと見る
対話をするときの姿勢、それは心構えの現れ
話をする姿勢、話を聴 姿勢。姿勢とは、心構えや態度を指しますが、これらが相手に受け入れられる状...
話をする姿勢、話を聴 姿勢。姿勢とは、心構えや態度を指しますが、これらが相手に受け入れられる状...
問題解決が進まないチームには、同じような「クセ」がある
問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...
問題の再発防止策を立てたはずなのに、また再発してしまう。これは、本当に辛いモノです。ありとあらゆる手を尽くしたにもかかわらず、再発して...
当事者意識や自覚を促すために必要な思考法とは
【この連載の前回：相手の理解度を下げないやさしい伝え方とはへのリンク】 自覚や当事者意識は、問題が発生したとき「 私がそのモノゴトに...
【この連載の前回：相手の理解度を下げないやさしい伝え方とはへのリンク】 自覚や当事者意識は、問題が発生したとき「 私がそのモノゴトに...
「人財教育・育成」の活用事例
もっと見る
製造業におけるコミュニケーション講座
【目次】 1、製造業におけるコミュニケーション講座 (1) 良好なコミュニケーションをとるための3つのプロセス (2) リアクションの重要性...
【目次】 1、製造業におけるコミュニケーション講座 (1) 良好なコミュニケーションをとるための3つのプロセス (2) リアクションの重要性...
リーダーに必要な素養：マネジメント能力とは
【目次】 ◆ マネジメントと問い合わせ対応は異なります 1、問い合わせの事例 2、オペレーションの一部になっているのはマネジメントではない...
【目次】 ◆ マネジメントと問い合わせ対応は異なります 1、問い合わせの事例 2、オペレーションの一部になっているのはマネジメントではない...
世界をリードするモノづくり中小企業の人づくり
以前、東京国際フォーラムで東京理科大主催のパネルディスカッションが開催されました。テーマは「ニッチトップで世界をリードする日本のモノ作り企業」。株式会社...
以前、東京国際フォーラムで東京理科大主催のパネルディスカッションが開催されました。テーマは「ニッチトップで世界をリードする日本のモノ作り企業」。株式会社...
