「業務マニュアルを作ろう」
そうなったとき、多くの会社では、まず Word や Googleドキュメントを開いて書き始めます。
ただ実際には、マニュアルの品質は、書き始める前にかなり決まります。
例えば、
- 人によって書き方が違う
- 表記がバラバラになる
- 説明の粒度が揃わない
- 同じ操作なのに説明が違う
- 後から更新すると全体が崩れる
- 担当者ごとに品質差が出る
こうした問題の多くは、文章力の差というより、「基準が決まっていない」
ことで起こります。
特に、
- SaaS操作マニュアル
- FAQ
- Help Center
- 業務手順書
のように、複数人で継続的に運用していくものは、
「どう作るか」を最初に決めておくことが非常に重要です。
この記事では、業務マニュアルの品質を安定させるために、最初に整理しておきたいポイントをまとめます。
マニュアルは、「書き始める前」に品質が決まる
マニュアル作成でありがちなのが、「とりあえず書き始める」という進め方です。
一見すると早そうですが、実はかなり崩れやすい進め方でもあります。
最初に基準がないまま進めると、書き手ごとに完成形が変わります。
- 細かく書き、ある人は簡潔にまとめる。
- スクリーンショット中心にまとめる。
- 文章中心になる。
その結果、全体を通したときに統一感がなくなります。
しかも、後から揃えようとすると手間が大きい。
本文を書き直すだけでなく、
- 見出し構造
- 表記
- 画像
- 説明の深さ
まで見直す必要が出てきます。
だからこそ、マニュアル作成では、「まず書く」より先に、
「どの品質を正とするか」を決めることが重要です。
言い換えると、「マニュアルを書く」前に、
「マニュアルのルールを作る」必要があります。
最初に決めるべきなのは、「誰のためのマニュアルか」
業務マニュアルで最初に整理すべきなのは、「誰が読むのか」という点です。
ここが曖昧だと、全体の説明方針がぶれます。
例えば、
- 新人向け
- 管理者向け
- 顧客向け
- ITに詳しくない方向け
では、必要な説明量は大きく変わります。
よくあるのは、書き手の知識レベルに引っ張られてしまうケースです。
特にエンジニアやベテラン担当者が作ると、
- 前提知識
- 用語理解
- 操作経験
があることを前提に書きやすくなります。
例えば、「設定画面からCSVを取り込みます」という一文だけでも、読む人によっては、
- どの設定画面なのか
- CSVファイルはどこにあるのか
- 権限は必要なのか
などが分からないことがあります。
作り方の前に、まず、「誰が読むか」を決める。
これが、業務マニュアルの精度を左右する最初のポイントです。
表記ルールは、文章力より先に決める
マニュアルでは、表記ルールの設計が非常に重要です。
実務では、ここが文章のうまさ以上に品質へ影響することもあります。
例えば、同じ操作なのに、
- クリック
- 押す
- 実行
- 選択
と、書き手ごとに表現が変わる。
これは実際によく起こります。
一般的なライティングでは、
- 同じ表現の繰り返しを避ける
- 言い換える
- 表現に変化をつける
ことが推奨されます。
ただ、マニュアルは少し違います。
例えば、「登録ボタンをクリックします」という説明を、ページごとに、
- 登録してください
- 登録を実行します
- 登録ボタンを押します
のように変えると、利用者は、「何が違うのか」を考え始めてしまいます。
マニュアルでは、「変えないこと」に意味があります。
同じ操作なら、同じ書き方にそろえる。
これだけでも、かなり読みやすくなります。
特に最初に決めておきたいのは、
- ボタン名
- UI名称
- メニュー名
- 英数字
- 全角半角
- 操作表現
- 括弧の使い方
などです。
ここが揃っていないと、全体の読みやすさが一気に落ちます。
表記ゆれ一覧を作ると、品質が安定しやすい
大規模な業務マニュアルでは、表記ゆれ一覧を作っておくと非常に効果的です。
例えば、
- CSV取込 → CSVインポート
- CSV読み込み → CSVインポート
- Log in → ログイン
- サインイン → ログイン
のように、「正式表記」をあらかじめ決めておく方法です。
特にSaaSや業務システムでは、
- 古い呼び名
- 英語UI
- 日本語UI
- 部署ごとの呼び方
が混ざりやすくなります。
そのまま書き始めると、ページごとに呼び方が変わり、利用者が混乱しやすくなります。
表記ゆれ一覧は地味ですが、全体品質を安定させるための土台になります。
「どれを正式名称とするか」を明確にするだけで、読みやすさも更新しやすさも大きく変わります。
表記ルールは、後から直そうとするとかなり大変
実際、表記ルールを決めないまま進めると、後からかなり苦労します。
例えば、
- CSV取込
- CSVインポート
- CSV読み込み
が混在した状態で100ページ作ると、後から全部探して直す必要が出てきます。
しかも途中で、「やっぱりこの呼び方に統一しよう」となると、本文だけでは済みません。
スクリーンショットの撮り直しや、FAQ修正、リンク名修正まで発生することもあります。
だから実務では、「まず書く」より、「まず基準を決める」ほうが、結果的に早いことが多いです。
レイアウトと構造を先に決める
業務マニュアルでは、本文だけでなく、「見た目」や「構造」の統一も重要です。
ここが揃っていないと、「別の人が作った感」が強く出ます。
例えば、
- 見出しサイズ
- スクリーンショット位置
- 注意書きの見せ方
- 手順番号の付け方
- 補足の置き方
など。
こうした要素がページごとに違うと、読み手は内容以前に疲れます。
そのため、複数人で作る場合は、「テンプレート」を先に決めておくのが有効です。
例えば、
- 概要
- 利用目的
- 手順
- 補足
- 注意点
のように基本構造をそろえておくだけでも、全体の品質は安定しやすくなります。
また、見落とされやすいのが、「粒度」です。
例えば、
- ログイン
- CSV登録
- エラー対応
- 受注処理
のように、見出しごとの粒度がバラバラだと、読者は全体像をつかみにくくなります。
- どのレベル感で1ページを作るのか。
- どこまでを1見出しにするのか。
こうした構造ルールも、最初に決めておく必要があります。
ゴールドサンプルを最初に作る
業務マニュアルの品質をそろえるうえで、とても有効なのが「ゴールドサンプル」です。
これは、「この品質を基準にする」という見本ページのことです。
意外と、この見本を作らないまま全体制作に入ってしまうケースは少なくありません。
しかし、大規模なマニュアルほど、最初の基準がないことが崩れの原因になります。
例えば、
- Aさんは説明が細かい
- Bさんは簡潔すぎる
- Cさんはスクリーンショットが多い
- Dさんは文章中心
という状態になる。
1ページ単体では問題なく見えても、100ページ、200ページと増えると、全体の違和感が大きくなります。
ゴールドサンプルには、
- どこまで説明するか
- 操作をどう表現するか
- スクリーンショットをどこまで入れるか
- 注意書きをどの粒度で入れるか
- FAQをどう書くか
- UI説明をどこまで細かくするか
といった判断基準を全部含めます。
つまり、本文そのもの以上に、「どう作るか」を共有する役割があります。
実際には、マニュアル本文よりも、この基準のほうが長く資産になることもあります。
システムやUIは変わっても、
- この粒度で書く
- この構造でそろえる
- このルールで統一する
という基準は残るからです。
マニュアルは、「上から順に読まれる」とは限らない
普通の記事は、上から順番に読まれることを前提に作られます。
しかし、業務マニュアルはそうとは限りません。
利用者は、「困っているページだけ」を開くことがよくあります。
つまり、途中のページから読まれる前提で設計する必要があります。
そのため、
- 同じ説明を必要な箇所で繰り返す
- 前提条件を再掲する
- 共通設定を最初にまとめる
といった構成には意味があります。
普通の記事では、同じ表現の繰り返しは避けた方が良いと言われます。
ただ、マニュアルは少し違います。
同じ操作なら、同じ書き方のほうが分かりやすいことも多い。
実際、利用者は上から順番に読むとは限りません。
困ったページだけ開くこともあります。
だから、「さっき説明したから省略する」より、
「必要な説明を一定ルールで再掲する」ほうが親切なケースもあります。
最後に重要なのは、「チェック体制」
マニュアルは、書いたら終わりではありません。
むしろ、公開前後のチェック体制が品質を大きく左右します。
確認すべき項目には、
- 表記ゆれ
- UI差異
- スクリーンショット
- 粒度
- 古い情報
- リンク切れ
などがあります。
特にSaaS系では、
- UI変更
- ボタン位置変更
- 文言変更
が頻繁に起こるため、「更新前提」で作らないとすぐに崩れます。
そのため、
- 誰が確認するのか
- どのタイミングでレビューするのか
- 更新ルールをどうするのか
- どこを定期チェックするのか
まで決めておくと、長期運用しやすくなります。
業務マニュアルは、作成時の完成度だけでなく、
「更新し続けられる仕組み」があるかどうかで価値が変わります。
自社でのマニュアル整備が難しい場合は、外部へ依頼する方法もあります。
業務マニュアルを外注する際のメリット・デメリットについては、以下の記事も参考にしてください。
まとめ｜業務マニュアルの品質は、「書き方」より「基準」で決まる
業務マニュアルは、単に文章を書けば完成するものではありません。
実際には、
- 誰向けに作るのか
- どの粒度で説明するのか
- どの表記を使うのか
- どういう構造にするのか
- 何を品質基準にするのか
を最初に整理することで、品質が安定しやすくなります。
特に複数人で継続運用する場合は、「基準づくり」が欠かせません。
- 表記ルール
- テンプレート
- ゴールドサンプル
- チェック体制
を先に整えておくことで、「誰が作っても一定品質になる状態」を作りやすくなります。
MANUAL EXPERT では、業務マニュアル制作やナレッジ整備、業務整理・運用支援などを通じて、現場で運用され続けるドキュメント・業務基盤づくりを支援しています。
業務ヒアリングをもとに、業務理解・構造整理・運用設計まで一貫して対応しています。
また、マニュアル制作や業務整理、大規模ドキュメント整備などの実績については、以下もご参照ください。
