マニュアル作成の工程として、欠かせないのが「原稿作成」。これはデザインやレイアウトの前段階として、情報を正確に伝えるための土台となる重要な作業です。しかし実際には、「何から書けばいいかわからない」「伝わる文章になっているか不安」という方も多いのではないでしょうか?
そこで本記事では、伝わりやすく実用的なマニュアルを作るために押さえておきたい、原稿作成における5つのポイントをご紹介します。
目次
マニュアルの原稿作成における5つのポイント
1.読み手を明確にする
まずは、「誰に向けたマニュアルなのか」という読み手を明確にしましょう。
例えば、新入社員向けのマニュアルとベテラン社員向けのマニュアルでは、表現や用語の使い方が大きく異なります。読み手の知識レベルや業務経験を考慮し、内容がスムーズに理解できるよう意識しましょう。
2.専門用語や難しい表現は避ける
専門用語や社内独自の用語は便利である一方、読み手にとって理解の妨げになってしまうことがあります。
対象者を問わず、マニュアルは「わからないことがあったときに読むもの」です。専門的な表現はできるだけ避け、簡単な言葉に置き換えたり、必要に応じて補足説明を加えたりしましょう。
また、社内だけで使われている独自の表現や略語も、読み手が混乱しないよう、見直しておくと安心です。
【例】アプリのキャッシュをクリアする。
→アプリがデータで重い場合は、設定画面から「保存データの削除」を行う。
【例】メタデータを参照し、CSVでエクスポートする。
→項目名などの基本情報を確認したうえで、CSVファイルとして保存する。
3.曖昧な表現は避け、具体的に書く
「定期的に」「しばらく」「できるだけ」といった曖昧な表現は、人によって受け取り方が異なり、行動のずれにつながる可能性があります。マニュアルでは、こうした曖昧な表現は避け、5W1H(いつ・どこで・だれが・何を・なぜ・どのように)を意識し、できるだけ具体的に記載することが重要です。
また、作業の判断基準や目安となる数値も記載することで、読み手が作業の正否を判断しやすくなります。
【例】定期的に清掃する。
→毎週月曜日の9:00~10:00に清掃する。
【例】温度が高くなりすぎないように注意する。
→本体の表面温度が60℃を超えないよう、温度計で確認する。
【例】ラベルがずれないように貼る。
→ラベルの下辺が製品本体の縁から5mmの位置に平行になるように貼る。
貼付後、目視で左右の余白が均等であることを確認する。
4.文章は簡潔にわかりやすく
マニュアルは業務の合間にサッと参照されることが多いため、回りくどい表現よりも、短くて端的な文章が求められます。主語と述語を明確にし、「誰が何をするか」がひと目でわかる構成を意識しましょう。また、漢字を多用しすぎると読みにくくなるため、適度にひらがなを交えると読みやすさが向上します。
【例】この作業を行う際は、担当者は必要に応じて確認しながら進めていく必要がある。
→作業前に、担当者はチェックリストを確認する。
【例】アプリの起動後においては、ユーザーがログインボタンを押すものとする。
→アプリを起動したら、ログインボタンを押す。
さらに、「アプリ」と「ソフト」など、同じ意味でも表記が統一されていないと、読み手が混乱する原因になります。あらかじめ表記ルールを決めておき、全体で統一するようにしましょう。
誤字脱字も違和感や不信感のもととなるため、原稿完成前に必ずチェックするようにしましょう。複数人で確認するのも効果的です。
5.箇条書きや図で視覚的に伝える
前述のとおり、マニュアルは短時間で確認されることが多いため、長文が続くと内容が頭に入りにくくなります。要点は箇条書きで整理し、手順や構造を示す場合には図やフロー図を活用しましょう。
【例】まずはパソコンを起動して、それから専用ソフトを開き、
社員番号を入力して、最後にログインボタンをクリックします。
→1.パソコンを起動する
2.専用ソフトを開く
3.社員番号を入力する
4.ログインボタンをクリックする
さらに、箇条書きに加えて、手順に対応した図や画像のキャプチャも用いることで、文章だけでは伝わりにくい情報も、視覚的に伝わりやすくなり、実用的なマニュアルになります。
▼フロー図については、以下の記事で詳しくご紹介しています。
まとめ
今回は、マニュアルの原稿を作成する際に押さえておきたいポイントを5つご紹介しました。
原稿の質は、そのままマニュアル全体の使いやすさに影響します。誤りや曖昧な部分があると、大きなミスにつながるおそれもあります。だからこそ、「正確に伝えること」と「わかりやすく書くこと」を意識して、丁寧に原稿を作成していきましょう。