Dojoシリーズ
Dojoコラム

コラム

システムマニュアル作成時に気をつけたいポイントをご紹介

  • このエントリーをはてなブックマークに追加

IT化が進み、多種多様なITシステムが業務を行う上で必要不可欠になりました。従業員も、業務の遂行のほかに、それらシステムの使い方を把握しなければならなくなります。

そんなときに活用されるのがシステムマニュアル(操作マニュアル)。このシステムマニュアルが読みやすいのとそうでないのとでは、業務の遂行のしやすさに大きな差が生まれるものです。

ここでは使いやすいシステムマニュアルにするための、作成時に気を付けたいポイントをいくつかご紹介します。

システム開発中からマニュアル作成に手を付けておく

マニュアルは、システム作成が完了してから書き始めるものだという考え方を持っている方も多いと思います。しかし、より使いやすいマニュアルを作成したいのであれば、システム開発中からマニュアル作りに着手したほうがいいです。

システム開発の期間が長くなると、初期段階の作業工程(システムのインストール方法など)については忘れてしまいがちです。そうなると、マニュアル作成時に、もう一度その工程を確認しなければいけなくなりますし、確認をおざなりに行ってしまえば、読み手にとって分かりにくい内容になってしまいます。
システムを開発しながらマニュアルをその都度書き進めることで、各工程に関する記憶もしっかりしていて、より具体的で分かりやすいマニュアルを作れることになるでしょう。

重要なことほど簡潔に書く

重要な工程については、より詳しく説明をしようと無駄に肩の力が入ってしまい、結果的に情報量が膨大になってしまいがちです。情報量が多くなれば、読む側が情報の取捨選択をすることにつながります。そうなると、肝心な情報が読み落とされてしまい、結局分かりにくいマニュアルになってしまう危険性があるのです。

マニュアルを作成する側は、まず、システムの標準的な使用法の簡潔な体系をまとめ、その中にある情報に重要度を把握する必要があります。そして、重要度の高い部分に関してはできるだけ簡潔にまとめ、メリハリのある読みやすいマニュアルを作るよう心がけましょう。

シンプルに、専門用語の多用は避ける

システムに関する知識のない人にとって、言葉だけで説明されるマニュアルは理解しにくいものです。情報量は必要最低限に抑え、できるだけシンプルな文章、単語で説明するようにしましょう。また、文章だけで説明することには限界があるものですので、画面キャプチャを使うなどして、視覚的に情報が入ってくるように工夫することも、分かりやすいシステムマニュアル作成のポイントです。

マニュアル作成ツールを利用する

システムマニュアルを作成するのであれば、マニュアル作成ツール「Dojo(ドージョー)」の利用がおすすめです。Dojoには、操作ログの記録という機能があり、ユーザーの操作に伴って必要な場面で画像を自動撮影しページレイアウトを自動構成することが可能です。そのため、操作についての紹介が複雑な部分であっても、Dojoが撮影した画像を添付するだけで、視覚的に理解できるマニュアルを作ることができますよ。

上記のほか、よくあるミスやトラブル、疑問点などを予め把握しておき、工程ごとにそれらの解決法などを簡潔に盛り込んでおくことも、分かりやすいシステムマニュアル作成のポイントのひとつです。また、システムは時間の経過とともに機能が使いされたり、改善がされたりするものですので、その都度マニュアルのほうも改定することも重要になります。改訂時のことも考え、マニュアルはシンプルなフォーマットで作成し、文章や情報の差し替えが容易に行えるようにしておきましょう。

  • このエントリーをはてなブックマークに追加

ワークスタイル変革を力強くサポートする
マニュアル作成ツール・共有ツール
「Dojoシリーズ」

すでにマニュアル作成ツール・共有ツール
「Dojoシリーズ」をご利用の方はこちら

お問い合わせ 無料
トライアル
資料
ダウンロード
ページ
トップ