機能や手順を伝える文章の書き方について

概要

ユーザ向けの資料を作成する際に役立ちそうな文章作成の勉強をしたので、ポイントをまとめておきます。

• ユーザが使う用語を使う
• 読む必要があるかわかるタイトルにする
• 日時の表現は「2020年12月15日」のような書き方にする。「2020/12/15」のような表現はしない。
• 数えられる数字は算用数字を使う。、熟語などで使用する場合(「一度に」など)は漢数字を使う。
• 記号の使い方に注意する。「・」は「と」、「／」は「または」の意味で使う。
• 一文一義を心掛ける。一つの文章に複数の話題を詰め込まない。
• 簡潔に書く。「…してくださいますようお願いします」など丁寧に書きすぎない。「したがって」「また」なども不要なことが多い。
• 主題から書く。最初に要求を言って、その理由を書くようにする。
• ユーザを主体にする。使う側の立場に立って、「～します」ではなく「～されます」の表現が好ましい場合もある。
• 列記には箇条書きを使う。順序性がある場合には項目に番号をつける。
• 長い文章には見出しを使う事で情報の区切りを明確にする
• 二重否定を使わない。「～しないと、しません」や「A以外を、削除しないでください」などは避けるようにする。
• 主語と述語の対応に気を付ける。主語と述語だけを残したときに文章がつながるか確認する。