部下の書いた技術文書を添削することがある方は,「マンガでわかる技術文書の書き方」を技術文書添削用のマニュアルとして活用してください。「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」がマニュアル(添削の基準)になります。
【内容が明確に伝わる技術文書の書き方の3原則】
◆第2原則:内容が明確に伝わる構成を考える
◆第3原則:内容が明確に伝わる書き方を考える
【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 | 文法を守って文を書く |
「書き方の3原則」と「6つのルールと18の書き方」に基づいて技術文書の添削をすれば,具体的な修正の指示ができます。例えば,以下のような指示ができます。
*会議の資料の流れがわかりにくい。会議の資料の構成を見直したほうがよい。
*この章での言いたいことがわかりにくい。この章の要点を冒頭に書いたほうがよい。
*調査結果に条件が書いてない。結果を強調しても条件が書いてないと結果が明確に伝わらない。条件と調査結果とをペアで書いたほうがよい。
*ここの箇所は,文の羅列で書いてあるので内容がわかりにくい。項目に分け,かつ,見出しを付けて書いたほうがよい。
*この文を読んでも頭の中に内容が浮かんでこない。具体的な文に書き直したほうがよい。
このように,具体的な修正内容の指示があれば部下も技術文書の修正がしやすいです。「君の書いた報告書はわかりにくいので修正してくれ」という指示だけでは,修正内容がわからないことがあるかもしれません。
「内容が明確に伝わる技術文書の書き方の3原則」と「6つのルールと18の書き方」に自分の書き方の考えも付け加えて,独自の添削用のマニュアルを作っても構いません。自分が使いやすいマニュアル(添削の基準)を作ってください。