「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」は,内容が明確に伝わる技術文書を書くうえで中心となるものです。
■「内容が明確に伝わる技術文書の書き方の3原則」とは,技術文書を書くうえでの考え方のことです。
■「6つのルールと18の書き方」とは,技術文書を書くうえでの具体的な書き方のことです。
◆第2原則:内容が明確に伝わる構成を考える
◆第3原則:内容が明確に伝わる書き方を考える
■第1原則は,内容が明確に伝わる技術文書を書くうえで最も重要な原則です。
■第2原則は,内容が明確に伝わる技術文書の構成(骨組み)を考えることです。
■第3原則は,第2原則で考えた構成(骨組み)に,6つのルールと18の書き方を使って肉付けをすることです。
ルール | 書き方と内容 | ||
ルール1 | 冒頭に書く | 書き方1 | 要点を冒頭に書く |
書き方2 | 全体像を冒頭に書く | ||
書き方3 | 枠組みを冒頭に書く | ||
ルール2 | ペアで書く | 書き方4 | 根拠を書く |
書き方5 | 条件を書く | ||
ルール3 | 分けて書く | 書き方6 | かたまりに分けて書く |
書き方7 | 箇条書きで書く | ||
書き方8 | 表で書く | ||
ルール4 | 視覚的に書く | 書き方9 | 写真や図を入れて書く |
書き方10 | 強調して書く | ||
書き方11 | まとまりを持たせて書く | ||
ルール5 | 合わせて書く | 書き方12 | 組み合わせて書く |
ルール6 | 明確に伝わる文を書く | 書き方13 | 具体的な文を書く |
書き方14 | 意味が明確な文を書く | ||
書き方15 | 能動態の文を書く | ||
書き方16 | 短い文を書く | ||
書き方17 | 肯定文で書く | ||
書き方18 | 文法を守って文を書く |
◆6つのルールと18の書き方とは◆
■6つのルールとは,具体的な書き方の考え方のことです。
■18の書き方とは,6つのルールに対する具体的な書き方のことです。
◆18の書き方について◆
18の書き方はオールラウンドプレーヤーです。
報告書,会議や打ち合わせで使う資料,提案書,企画書,メールなどあらゆる技術文書を書くときに18の書き方を使うことができます。
一層美味しい料理を作るためには隠し味が必要です。
「内容が明確に伝わる技術文書」という料理を一層美味しく作るための隠し味が,「伝える内容を明確に理解していること」と「頭の中を整理すること」です。
伝える内容を明確に理解していることとは「理解している」です。
この逆が「理解したつもり」です。理解したつもりとは,伝える内容を自分は理解していると思っていても,実際は,理解していなかったことです。
書き手が理解したつもりで書いた技術文書を読み手が読んで「内容が明確に伝わった」と言うことはありません。
理解していること,つまり,伝える内容を明確に理解していることは,内容が明確に伝わる技術文書を書くうえでの条件の1つです。
自分の頭の中を整理してから技術文書を書いてください。
「これを書こう,これを書かなきゃ,あれを書こう,あれも書かなきゃ」のように頭の中がごちゃごちゃした状態で技術文書を書くと「内容が伝わる技術文書(=内容が明確に伝わらない技術文書)」を書いてしまいます。
例えば,書き手の言いたいことがわかりにくい技術文書を書いたり,文の羅列で技術文書を書いたりします。
頭の中を整理したうえで技術文書を書くことは,内容が明確に伝わる技術文書を書くうえでの条件の1つです。