「君の書いた技術文書はわかりやすい」と言われる技術文書の書き方(その39)

「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その29)」で,「必要なこと」として,「伝える内容を明確に理解していること」「頭の中を整理すること」の2項目があることを解説しました。今回は,「頭の中を整理すること」についての解説です。

 

■頭の中の整理方法
「内容が明確に伝わる技術文書の書き方の3原則」「6つのルールと18の書き方」を使って書くことは頭の中を整理して技術文書を書くことです。

=

■頭の中の整理方法の例
「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その12)」で,内容を明確に伝えるため,【パターンⅠ】のメールを【パターンⅡ】のように書きました。

 

【パターンⅠ】
昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

「A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する」とのことだった。

「今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送って欲しい」との指示があった。

〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

【パターンⅡ】
昨日A社に、我社の〇〇管理システムの導入を提案しました。その打ち合わせ結果を報告します。

1.打ち合わせでの結論
〇〇管理システムの導入に関する結論は出なかった。A社のような規模や事業内容で〇〇管理システムを導入した場合の具体的な効果と具体的な管理コストの削減額を確認したうえで導入するかどうかを決定する。

2.打ち合わせでの指示事項
今週の木曜日の17時までに、効果と削減額をA社の山田部長までメールで送る。

3.今後の予定
〇月〇日の10時からA社で行う次回の打ち合わせでA社の結論を話す。

以 上

 

パターンⅡのメールを書くときには,「書き方の第2原則:内容が明確に伝わる構成を考える」「書き方1:要点を冒頭に書く」を使って頭の中を整理しました。
「『君の書いた技術文書はわかりやすい』と言われる技術文書の書き方(その14)」「同(その15)」では,「書き方6:かたまりに分けて書く」「書き方8:表で書く」を使って頭の中を整理しました。

 

■頭の中を整理してから書く
「これを書こう,これを書かなきゃ,あれを書こう,あれも書かなきゃ・・・」というような頭の中が混乱した状態で技術文書を一気に書き出すことがあると思います。しかし,一気に書き出さないでください。このような状態で書くと内容が明確に伝わらない技術文書を書いてしまうことがあるからです。一度立ち止まり「内容が明確に伝わる技術文書の書き方の3原則」「6つのルールと18の書き方」を使って頭の中を整理してください。

 

次回に続きます。

 

【参考文献】
森谷仁著,「マンガでわかる技術文書の書き方」,オーム社,令和4年3月25日

タイトルとURLをコピーしました