マニュアル作成

2023年4月23日システム開発,内製化,技術情報

形容詞は、名詞の前に付けることで、その名詞の姿や形などの特性を説明します。
例えば、美しい川の「美しい」、青い海の「青い」が形容詞です。
今どきの若者は、この形容詞の前に、さらに形容詞をつけて会話を楽しんでいます。
それは、「激」「鬼」「クソ」「ガチ」などです。
これらは、アニメから学びました(笑)
ところで、ChatGPTの展開が、鬼ヤバイですね。
AI(人工知能)に仕事を奪われないための対策を模索中です^^;

マニュアルのメリット

以前の「手順を組み込む」というエントリーで、マニュアルの存在意義について触れました。
今回は、開発したシステムのマニュアル作成について、もう少し掘り下げて書いてみます。
まず、マニュアルを作成するメリットについて、オサライします。
メリットは、大きく分けて3つあります。
1つ目のメリットは、「教育コストの削減」です。
利用者が多いシステムでは、操作手順を一人ひとりに説明したら、膨大な時間がかかります。
かといって、集合教育では受講者のITリテラシーにバラツキがあって効率良く教えることは難しいです。
マニュアルは、マンツーマンでの説明や集合教育を補完して、各人が必要に応じて学ぶことができます。
中途入社や部署異動で、初めてシステムを使うことになった社員に利用方法を教える時、教える側と教わる側の時間を格段に短縮することができます。
次のメリットは、「ユーザー満足度向上」です。
ユーザー自身が、すぐに不明な箇所を調べて自己解決できるようになります。
運用管理者側にとっても、問合せに対応する時間や手間を削減することができます。
最後のメリットは、「属人化を防ぐ」です。
担当者が病気や怪我で急遽出社できなくなった時の対応では、マニュアルの有り無しが雲泥の差となります。
また、マニュアルがないと、ユーザーは、それぞれの解釈で癖のついた使い方をするようになります。
作業効率の悪い手順が、後任者に引き継がれるリスクを防ぐこともできます。

マニュアルを設計する

マニュアル作成時に意識するポイントは、対象読者が何をすれば良いかを端的に伝えることです。
この「端的に」とは、いかに枝葉末節を排除して、操作手順を示せるかが大事です。
そのためには、実際に使うユーザーに成り代わって想像力を働かせることです。
ユーザーが理解できない専門用語は、使わない。
ユーザーが、どこまでの前提条件を理解しているかをよく把握する。
マニュアルの構成を組み立てるために、最初に目次の作成に着手すると良いでしょう。
ユーザーが知りたいことを目次で探せると、歓迎されます。
目次は、見出しで構成されます。ユーザーは、見出しから「自分が読むべきか」を判断できます。
見出しの階層が深いと目的の操作方法を探すことが困難になります。
見出しは、章・節・項の3階層以内が良いと思います。

各構成要素

マニュアル本文の基本構成要素は、「見出し」「リード文」「操作手順」「注意・補足」です。
「見出し」のポイントは、目的を記述することです。手段の記述はNGです。
例「【並び替え】ボタンをクリックする」(NG)→「納入日で並び替える」(OK)
「リード文」は、「見出し」のすぐ下に挿入します。
「リード文」の役割は、操作のメリットや目的を伝えることです。(機能の説明だけではNG)
そのページで何を説明しているか、なぜ、その操作をするのか、どんなメリットがあるのか、どういうシーンで必要な操作なのか等を説明します。
「操作手順」では、手順とそれ以外の情報は明確に区別することがポイントです。
意外に、この区別ができていないマニュアルが多いですね。
ボタンやメニュー名は「」で囲む。複数の画面操作を一つの手順にまとめない。
文章だけで理解できる操作手順を書く。(挿入画面に頼らない)
「注意・補足」の役割は、ユーザーの不利益、エラーにつながる可能性の示唆、あるいは、制限事項がある場合や付け加えたいこと、操作のコツ、関連情報などを記載すると良いでしょう。

発行後の管理

マニュアルは、発行後の管理が大切です。
読まれるべき人に配布されているか、常に最新の状態に改訂しているかです。(改訂履歴も付けたほうが良い)
マニュアルの作成ツールは、自分が使え慣れたものを使えばよいです。
筆者は、もっぱらWordを使っています。(目次の更新機能が好き)
ただし、1ページで完結する手順書は、Excelを使うことが多いです。
説明会の資料がそのまま使えそうな場合は、PowerPointを使います。
マニュアルに動画を採用することも増えてきました。YoutubeやTikTokの影響なのですね。
さらに、Eラーニングシステムとマニュアルを連携させて、理解度の把握や新人配属時のカリキュラム化も検討に値します。

皆さん本日もお疲れ様でした!
おやすみなさい(挙手)

☆おすすめ情報☆☆☆
 企業様で、ExcelやAccessのシステム化を考えておられましたら、既存のExcel、Accessをそのまま使えて、大事なデータはすべてDB保存するdbSheetClient(ディービーシート・クライアント)をおすすめいたします。

dbSheetClient(ディービーシート・クライアント)の紹介ホームページへ
Accessでお困りの企業様は、こちらを,、ご覧になってみてください。
☆☆☆・・・☆☆☆・・・☆☆☆