【この連載の前回:“技術文書を書くこと”について考える(その4)へのリンク】
今回から、「内容が明確に伝わる技術文書」の書き方について解説します。
1.内容が明確に伝わる技術文書を書くための4項目
以下の4項目を「理解・習得・実践」することで、内容が明確に伝わる技術文書を書くことができます。
- (1)重要なことを理解する
- (2)書き方の技術を習得する
- (3)必要なことを理解する
- (4)日々のオンザジョブトレーニングを実践する
(1)重要なことを理解する
これは、内容が明確に伝わる技術文書を書くうえで重要なことを理解することです。重要なこととは、「技術文書を書く目的」や「“伝わる”と“明確に伝わる”の違い」などです。これらを理解することで、内容が明確に伝わる技術文書を書く必要性がわかります。これまでの4回で解説したことは「重要なことを理解する」に関する内容です。
(2)書き方の技術を習得する
これは、「内容が明確に伝わる技術文書の書き方の技術」を習得することです。書き方の技術とは、「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」です。これらは、内容が明確に伝わる技術文書の書き方の中心となる内容です。
(3)必要なことを理解する
これは、内容が明確に伝わる技術文書を書くうえで必要なことを理解することです。必要なこととは、「伝える内容を明確に理解していること」と「頭の中を整理すること」です。これらを理解することで、書き手が、伝える内容を理解しかつ整理できていることの重要性がわかります。
(4)日々のオンザジョブトレーニングを実践する
これは、継続学習(日々のオンザジョブトレーニング)をすることです。日々のオンザジョブトレーニングの実践で、内容が明確に伝わる技術文書の書き方が習得できます。また、書き方がレベルアップします。「継続は力なり」です。
内容が明確に伝わる技術文書を書くための4項目のうち、「重要なことを理解する」についてはこれまで4回にわたり解説しました。次回から「書き方の技術を習得する」、「必要なことを...
【参考文献】
森谷仁著、「マンガでわかる技術文書の書き方」、オーム社、令和4年3月25日
◆関連解説記事「書くべきことを自分の頭の中ではっきりさせる」