「マンガでわかる技術文書の書き方」の説明の第6回として,3つの視点の中の「内容が明確に伝わる技術文書の書き方の技術:内容が明確に伝わる技術文書の書き方の3原則」を説明します。
「内容が明確に伝わる技術文書の書き方の3原則」とは以下の3項目です。
第1原則:書き手と読み手の違いを認識する。
第2原則:内容が明確に伝わる構成を考える
第3原則:内容が明確に伝わる書き方を考える
_
■「第1原則:書き手と読み手の違いを認識する」について
第1原則とは,書き手とは“知っている人”,読み手とは“知らない人”を認識することです。
第1原則の「書き手と読み手の違いを認識すること」が,内容が明確に伝わる技術文書を書くための一丁目一番地です。
書き手と読み手の違いを認識していれば,例えば,
*読み手が知りたいこと(要点)を冒頭に書こう
*この内容を文の羅列で書くと内容がすぐに理解できないので表で書こう
*ここは文章だけではなく写真や図を入れて書こう
*具体的な内容の文を書こう
などのように考えて技術文書を書きます。
■「第2原則:内容が明確に伝わる構成を考える」について
第2原則とは,内容が明確に伝わる技術文書の構成(骨組み)を考えることです。
A4判の用紙1枚で書く技術文書もA4判の用紙200枚で書く技術文書も以下の4つのポイント(項目)に基づき,内容が明確に伝わる技術文書の構成(骨組み)を考えます。
1:内容を項目に区分する
2:技術文書の軸を決める
3:軸となる項目を細分化する
4:技術文書のストーリーを確認する
■「第3原則:内容が明確に伝わる書き方を考える」について
第3原則とは,内容が明確に伝わる技術文書の構成(骨組み)に,“6つのルールと18の書き方”を使って肉付けをすることです。
第3原則については,別ブログで説明します。
次回に続きます。