「マンガでわかる技術文書の書き方」の内容の説明:第3回

「マンガでわかる技術文書の書き方」の内容の説明の第3回として,「本書の内容の特徴」を説明します。本書の内容の特徴とは,以下の2つの項目を解説していることです。

■特徴1:3部構成としたこと
内容が明確に伝わる技術文書の書き方を3部構成で解説しました。3部構成とは,マンガ部会話形式部およびテキスト解説部です。

■特徴2:3つの視点から解説したこと
3つの視点で,「内容が明確に伝わる技術文書の書き方」を解説しました。3つの視点とは,以下のⅠ~Ⅲの項目です。

Ⅰ.内容が明確に伝わる技術文書の書き方の技術
①内容が明確に伝わる技術文書の書き方の3原則
②6つのルールと18の書き方
*①と②が,「内容が明確に伝わる技術文書の書き方」の中での中心となる内容です。また,「内容が明確に伝わる技術文書の書き方」の基礎となる内容です。
様々な書き方の事例を使って「6つのルールと18の書き方」を解説します。これも本書の特徴の一つです。

Ⅱ.内容が明確に伝わる技術文書を書くうえで必要なこと
①伝える内容を明確に理解していること
②頭の中を整理すること
*内容が明確に伝わる技術文書を書くうえで必要なこととは,内容が明確に伝わる技術文書を書くうえで書き手が認識すべきことです。

Ⅲ.日々のオンザジョブトレーニングを実践する
*日々のオンザジョブトレーニングの実践が,内容が明確に伝わる技術文書の書き方の技術(書き方の3原則と18の書き方)の習得とそのレベルアップの鍵を握っています。

別ブログでⅠ~Ⅲの解説をします。

次回に続きます。

トップへ戻る