システム操作マニュアルを作るための試行錯誤 その1
はじめに
私は社内システムの操作マニュアルを作りたいと思っています。
それも、「みんなが幸せになる社内システムの操作マニュアル」です！
それはどんなマニュアルなのか・・・。
私なりに考えた結果、この人たちにとって使いやすいマニュアルとしました。
- 操作をする人
- 操作を教える人
- 問い合わせ対応する人
- マニュアルをメンテナンスする人
しかし、この人たちが使いやすいマニュアルを作成するには考えないといけないことがたくさんあります。
なので、マニュアルに載せる情報の整理と、試行錯誤の記録を残したいと思いブログを書くことにしました。
今回は「社内でデータポータルの操作をする」と仮定して、データポータルの操作マニュアルの要素を考えていきます！
目次
参考資料
主に以下の資料を活用します。
◆ノンプロ研・技術ライティング講座資料
◆仲田尚央さんのspeakerdeck speakerdeck.com
◆ヘルプサイトの作り方 gihyo.jp
◆良いFAQの書き方 gihyo.jp
前提
マニュアルを活用する会社の社内環境は以下と仮定します。
よって、googleアカウント取得方法などの説明は割愛します。
操作マニュアル作成前に決めること
マニュアルの目的は「使い方をユーザーに伝える」です。
では、良いマニュアルにはどんな要素があるのでしょうか。 参考資料をもとに調べてみました。
- 内容が理解しやすい
- 内容が正確である（一意に伝わる）
- 欲しい情報が見つけやすい
- メンテナンスしやすい
では、この要素を網羅するために、操作マニュアル作成の企画書を考えたいと思います。
企画書には以下の項目を記載します。
- タイトル
- ターゲット
- ベネフィット
- 構成案
- 販促案
- 注意点
- 記事の書き方
次回から、タイトル以降を決めていきます！
おわりに
なかなか決めることが多いです・・・。でもここで整理しておけば、実際にマニュアルを作るときにラクになるはず！と思って前進しようと思います。
