t-hom’s diary

主にVBAネタを扱っているブログです。

業務マニュアルを作る際に重要な3つのポイント

今回は業務マニュアルを作る際に重要な3つのポイントを紹介する。

私が重要だと思うポイントは、指示の明確さ、メンテナンス性、読みやすさの3点である。
以下にそれぞれ詳しく解説する。

指示の明確さ

業務マニュアルは作業者に対し、何をすればよいのか明確に伝える必要がある。
これまで見てきた指示文のスタイルはおおむね3パターンある。

行為名で終わるパターン

以下の例では「行為名」で終わっているためコンパクトにまとまるが、状況によって勘違いの元になる。

1) ○○の設定変更
2) ○○をクリック
3) サーバーの再起動

たとえば、手順2で○○をクリックしたことで自動的に再起動されるにも関わらず上記のような表記になっていると、作業者への指示が不明瞭ということになる。

動詞で終わるパターン

以下の例では「動詞」で終わっているためややコンパクトにまとまるが、こちらも状況によって勘違いの元になる。

1) ○○の設定を変更する
2) ○○をクリックする
3) サーバーを再起動する

上の例はシンプルなので間違えようがないと思うが、たとえば登場人物が複数になり、システムによって処理される項目も含まれてくると、作業者への指示と、そうでないものを混同してしまうこともあるかもしれない。

指示で終わるパターン

以下の例では「指示」で終わっているため文が長くなるが、作業者への指示であることが明確だ。

1) ○○の設定を変更してください。
2) ○○をクリックしてください。
3) サーバーを再起動してください。

これが一番確実に伝わると思うので、私が今後作るものは指示終わりで統一しようかと思っている。

メンテナンス性

マニュアルは業務の変化に合わせて常に最新に保たれなければならないが、メンテナンス性が悪いと更新が億劫になる。
特に普段自分ひとりで対応している業務はマニュアルを見なくてもできてしまうため、マニュアルの更新を後回しにしたり、更新するつもりで失念してしまうことだってある。
しかしいざ自分が休んだとき、引き継いだ方が古いマニュアルを参照してしまうとミスオペの元になるのでこれは大変危険。

更新が億劫にならないよう、メンテナンス性の高いマニュアル作りが重要だと思う。

最近気づいたのだが、メンテナンス性を高めるために一番重要なのは、「凝らない」ということだと思う。
基本的にはWordのスタイル機能を活用してテンプレートを作ってしまい、あとはテンプレート任せにしてしまうのが楽だ。

【参考】スタイル機能については以下のページで簡単に紹介した。
Wordの真価 - You.Activate

メンテナンス性についてはWordのテクニックなども関係してくるので後日別途記事を書くつもりである。書いた。
thom.hateblo.jp

読みやすさ

読みやすさにも色々な観点があり、ここでは閲覧性・一覧性・本文の読みやすさについて紹介する。

閲覧性

欲しい情報にすばやく辿りつけること。
見出しを正しく設定することでナビゲーションバーからアクセスできたり、見出しを目だたせたり表現をわかりやすく工夫することで知りたい情報を見つけやすくする。

一覧性

見渡しの良さのこと。手順数に比べてページ数を使いすぎると、延々とページめくりさせられるようなマニュアルになり、一覧性が下がる。
一覧性を下げる大きな要因は、説明のための画像である。不要な箇所をトリミングしたり、全体の一部を拡大するような表現でコンパクトにすると一覧性があがる。

悪例) 縦幅が大きく、一覧性を下げるスクリーンショット
この例では全体を収めようとしているため必要部分が小さくて見づらいというデメリットもある。
f:id:t-hom:20170628032434p:plain

改善例 1) 不要部分をトリミング
トリミングは画像を選択した際に表示される「図ツール」タブから行える。
ついでに少し大きくリサイズして見やすくした。
f:id:t-hom:20170628032605p:plain

改善例 2) 全体を小さく見せつつ、必要部分だけズーム
ズーム画像はクイックスタイルで影をつけて前面に浮かせたような表現にする。
ズームの台形の作り方は、四角形を配置して右クリックし、頂点の編集を行い、枠線を消して塗りつぶしをグラデーションにする。
ズーム方向に色が薄くなるグラデーションにすると色の拡散でズームが表現できる。
f:id:t-hom:20170628032947p:plain

本文の読みやすさ

本文の読みやすさは、フォント、行間、行幅、書式で決まる。

フォントについて

印刷する場合、本文は明朝、見出しはゴシックにするのが基本。また強調したい単語もゴシックにする。
また、日本語の場合は等幅フォント、英語は文字によって幅が変わるプロポーショナルフォントが基本。
※ちなみにMS明朝は等幅、MS P 明朝はプロポーショナル。

ただしMS明朝・MSゴシックはドットの粗が目立つので、主に画面で見る場合はメイリオが読みやすい。メイリオプロポーショナルフォントだが日本語でもそれほど字詰まりを感じない。

f:id:t-hom:20170628035952p:plain

Wordでメイリオを使う際の注意点は以下参照。
thom.hateblo.jp

本文のフォントサイズはユニバーサルデザインを考慮して12ポイントがおススメ。
※職場の年齢層によっては14ポイントくらいあっても良いかもしれない。

行間について

行間が詰まりすぎたり、広すぎたりすると読みづらくなる。文字サイズの0.5~0.8倍くらいが良いと思う。

【参考】
文章の作り方|伝わるデザイン

行幅について

行幅は1行あたりの文字数で決まる。
狭すぎるても広すぎても読みづらいので、35~40文字程度がおススメ。

書式について

赤字・太字・下線を多用するとゴテゴテするのでよろしくない。
thom.hateblo.jp

市販の書籍をイメージしてマニュアルを作る

私は業務マニュアルを作る際、市販の書籍をイメージする。
小説などはあまり参考にならないので、プログラミングの学習書やHow To本など、何かを解説している書籍を参考にすると良い。

市販の書籍はプロの編集者がフィルターになっている為、非常に読みやすい。
強調表現であるゴシック体や太字がどういう箇所にどのくらいの割合で使われているか、一行あたりの文字数はどれくらいか、文字サイズに比べて行間のサイズはどうか、見出しの階層はどれくらい深いかなど、読みやすい文書のスタイルは市販の出版物から学べる。

ただし、何を真似るかは適切に取捨選択すること。
市販の書籍は売るために手間をかけて工夫を凝らすが、業務マニュアルにおいてその手間がメンテナンス性の低下につながるようではいけない。
マニュアル作成は凝りだすとキリがないので、その工夫はオペレーションミスを減らすのか、それともただの自己満足なのかよく自問したい。

書籍紹介

業務システムのためのユーザーマニュアル作成ガイド

業務システムのためのユーザーマニュアル作成ガイド

こちらはマニュアル作成の指針から適切な文章の書き方、マニュアルの校正や保守までマニュアルにかんするあらゆるトピックを扱った貴重な本。ITエンジニア必携とあるが、まさにそのとおり。マニュアル作成に携わるすべての人に読んでほしい書籍だ。

根本から理解する Wordの「スタイル」活用読本 [Word2010/2007/2003/2002対応] (Wordで作ったWordの本)

根本から理解する Wordの「スタイル」活用読本 [Word2010/2007/2003/2002対応] (Wordで作ったWordの本)

こちらはWordでスタイルを使いこなすために必要な知識が得られる本。メンテナンス性の高いドキュメントを作るには、まずスタイルの理解から。知っているのと知らないのでは全く効率が変わってくる。

当ブログは、amazon.co.jpを宣伝しリンクすることによってサイトが紹介料を獲得できる手段を提供することを目的に設定されたアフィリエイト宣伝プログラムである、 Amazonアソシエイト・プログラムの参加者です。