システム操作マニュアルを作るための試行錯誤 その4
はじめに
引き続き、「社内でデータポータルの操作をする」と仮定して、データポータルの操作マニュアルの要素を考えていきます。
前回の記事はこちらです。
以前決めた操作マニュアル作成の企画書の項目は以下のとおりです。
- タイトル
- ターゲット
- ベネフィット
- 構成案
- 販促案
- 注意点
- 記事の書き方
今回の記事では、マニュアル作成においての注意点を洗い出します。
目次
マニュアル作成においての注意点
一旦、マニュアル作成における懸念点を列挙してみます。
- 求める情報が人によって違う
- 情報の探し方が違う
- 知りたいことがあいまい
- 知りたいことが明確
- 網羅的に知りたい
- 一意に伝わる必要がある
- 一部しか読まれないことも多々ある(流し読みされる)
このあたりは、マニュアルの構成や記事の書き方を考えるうえで重要な注意点になりそうです!
ただ、構成や記事の書き方は次回以降に考えるので、今回は別の注意点を考えてみます。
まず、マニュアルはなんのために存在するのか・・・。
大きな括りで考えると「システム操作する人が、操作方法を知るため」なので、その視点で注意点を洗い出してみました。
- 読み手が理解しやすいマニュアルの書き方
- 操作する人の目線で書く
- はじめて操作する人に必要な項目
- 初期設定
- チュートリアル
- 統一性をもたせるために用意する項目
- 用語集
- スタイルガイド
- 各記事のフォーマット
このあたりのことが決まっていると、マニュアルの流れのようなものができてきます。
すると、マニュアルの読み手も書き手もスムーズに操作や執筆ができるのではないでしょうか。
おわりに
マニュアル作成において注意することを明確にしました。これで実際に書くときに迷いが減るはずです!!
次回はとうとう「構成案」について書きます。
構成は、マニュアル作成の肝だと思っているので、気合を入れないといけないですね!!
◆今までの「システム操作マニュアルを作るための試行錯誤」の記事一覧
システム操作マニュアルを作るための試行錯誤 その1 - Kの備忘録(仮)
システム操作マニュアルを作るための試行錯誤 その2 - Kの備忘録(仮)
システム操作マニュアルを作るための試行錯誤 その3 - Kの備忘録(仮)