今回は,「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その41)」で解説した日々のオンザジョブトレーニングに関する4つのトレーニングの後半です。
①基本のトレーニング(その41)
②会話を通したトレーニング(その42・その43)
③概要版の作成を通したトレーニング(今回)
④自己添削を通したトレーニング(今回)
■概要版の作成を通したトレーニング
このトレーニングは,内容が明確に伝わる技術文書の書き方を使って仕事(業務)の成果を概要版として作成することです。A3判の用紙1枚以内など制限枚数以内で仕事(業務)の概要版を作成します。制限枚数を設けたうえで概要版を作成するためには以下のことを行う必要があります。
①制限枚数以内で概要版を書くための構成を考える(書き方の第2原則)。
②構成の中に書くべき内容を絞り込む。
③絞り込んだ内容を制限枚数以内で書くための書き方を考える(書き方の第3原則)。
このような手順となるため制限枚数以内で概要版を作成することは大変です。しかし,これらの手順で作成することから,内容が明確に伝わる技術文書の書き方が習得できます。また,この書き方がレベルアップします。
【参考】
「マンガで学ぼう・ダウンロードコーナー」から,「概要版を作成するときのポイント」と「概要版の作成例」がダウンロードできます。概要版を作成したことがない方はこれらの資料を参考にしてください。
■自己添削を通したトレーニング
このトレーニングは,技術文書を書いたらその内容が明確に伝わるかどうかを自分で添削することです。「自分が書いた技術文書を読み手の立場に立って添削する」という視点で行うトレーニングです。
自己添削では,自問自答しながら自分が書いた技術文書をチェックしてください。例えば,以下のような視点でのチェックです。
*書き手と読み手の違いを認識して書いているか?
*内容が明確に伝わる構成になっているか?
*冒頭に書いているか?
*ペアで書いているか?
*分けて書いているか?
*視覚的に書いているか?
*合わせて書いているか?
*明確に伝わる文を書いているか?
次回に続きます。
【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日