現場で伝わる、使われるマニュアルづくり
マニュアル作成のコツ
企画・設計の心得
- 目的（目指すべき姿）を明記する。
- 誰が読むか（対象者）を具体的に決める。
- 利用シーンを想定して構成する。
- 「どんな場面で参照されるか」を考える。
- kintoneや他のクラウドツールなど一元管理する場所を最初に決める。
- 作成範囲を明確にして盛り込みすぎない。
- 構成を先に設計してから本文に着手する。
- 大見出し・中見出しの粒度を統一する。
- タイトル命名ルールを決めておく。
- バージョン管理をする。
- 履歴で内容変更が分かるようにする。
- 履歴で元に戻せるような機能を利用する。
- 構成や文書作成は生成AIと共創する。
- 長文よりも「手順書＋補足資料（図や画像）」にするよう心掛ける。
- タイトルは読んで即理解できるように。
- 更新する人を決めておく。
- 改訂のルールを明文化しておく。
文章・表現のコツ
- 文体は「です・ます」または「である・だ」のどちらかで統一する。
- 主語と述語を明確にする。
- 指示語（これ・それ）を具体語にする。
- 難しい表現は平易に言い換える。
- 専門用語は初出時に説明を添える。
- 否定形ではなく肯定形で書く。
- 箇条書きを積極的に使う。
- 数字は半角に統一する。
- 「1」「①」などの表記は全体で揃える。
- 同じ意味の言葉を使い分けない（例：実施＝実行）。
- 英語・カタカナ語は必要最小限に。
- 「なぜその操作をするか」という意図を書く。
- 注意・補足・例などを区別して書く。
- NG例もあえて載せると理解が深まる。
- スクリーンショットと本文を離さない。
- 図の下にキャプションを入れるとわかりやすい。
- 「押す」「選ぶ」など動詞を統一する。
- 書き手の感情や意見は省く。
- 他のページを参照する場合はリンクや番号を明記する。
- 改行位置を意識して読みやすくする。
デザイン・レイアウトのコツ
- デザインを統一する。
- 見出しの階層を一目で区別できるようにする。
- フォントとサイズは全体で統一。
- 強調は太字を基本とする。
- 色数は3色以内に抑える。
- 背景色と文字色のコントラストを確保する。
- 表や図の罫線は薄いグレーで統一させる。
- ページごとに余白を均等に取る。
- ページ番号・発行日を必ず記載する。
- スクリーンショットの解像度を揃える。
- 図表は左寄せで統一。
- フローチャートを使って全体の流れを見せる。
- 注意・警告・禁止のアイコンを決めておく。
- 図や表には通し番号を付ける。
- 改訂箇所を色で明示すると親切。
- 紙に印刷しても見やすいデザインにする。
- モバイル閲覧を想定した文字サイズに。
- アイコンは自社内で統一ルールを決める。
- 画像のトリミングや余白は整える。
- ページの最初に概要図を置くと全体がつかめる。
- 表紙にマニュアル名と版数を明記する。
- デザインガイドラインを1ページにまとめておく。
- 図版と手順番号をリンクさせる。
- チェックリスト形式も活用する。
コンテンツ構成のコツ
- 手順は番号を振って順序を明確に。
- 操作の目的を最初に書く。
- 前提条件（準備・権限）を最初にまとめる。
- 操作結果（どうなるか）を示す。
- トラブル発生時の対応策を入れる。
- 関連マニュアルへのリンクを貼る。
- よくある質問（FAQ）を付けるとよい。
- トラブルシューティングは章を分ける。
- 短い操作動画を埋め込むと理解が早い。
- 用語集を巻末に入れるとよい。
- 画像は実際の画面と同じにする。
- 「例：」「補足：」等を文頭で統一する。
- 「完成」と思える終わり方にする。
- 操作後の確認方法を書くとよい。
- 改訂箇所をマーカーで示す等わかりやすくする。
- 導入・操作・まとめの三部構成を意識する。
- 作業前に必要なものリストを明記する。
- kintoneの場合、関連アプリとの関係を説明する。
- 現場で使う言葉を使う。
- シナリオ（業務の流れ）で説明する。
- どの順番だと効率的かを考えながら手順を書く。
- 完成したら実際に試してみる。
