日頃はシステムの操作マニュアル制作を担当している管理人ですが、
初めて操作マニュアルを作成したとき、操作マニュアルの作成から公開までの流れがわからず戸惑ったことがあります。
今では回数を重ねることで、慣れてきました。
大企業であれば業務の引継ぎがあり、スムーズに始めることができるかもしれません。
しかし、中小企業や起業したばかりの会社であれば、いざ操作マニュアルを作成するときの手順について資料が無いことがあります。
（実際に私の場合は、前任者からの引き継ぎや業務マニュアルが無かったんです・・・泣）
本記事では、
- 操作マニュアルの制作を担当することになった人
- これから操作マニュアルの制作を仕事にしていきたい人
- はじめて操作マニュアルを作成する人
のような人に向けて、マニュアルを作成するときの全体的な流れをまとめました。
「こんな感じで進めていけばいいのかー」と参考になれば幸いです。
■ 目次
作成手順１.仕様・要件の確認
まずは、書くべき内容がどんな内容なのかを確認します。
取り組む案件や会社によって渡される資料は異なりますが、
仕様書、設計書、要件書などが該当します。
分量にもよりますが、ここで確認にかかる目安時間は以下ぐらいかけて私は確認しています。
・既存の機能を微修正、機能を一つ追加→１時間以内
・新規製品の開発→３時間以内
はじめは見慣れないので、わからない部分もあります。
ここでのポイントは、全体を把握することです。
覚える必要はないです。
自分がどんなことを書くのか、イメージすることが目的です。
全体を把握することでスケジュールの計画やマニュアル作成しやすくなります。
作成手順２.スケジュールの計画・連絡
次に、自分の力量ではどのぐらいの工数(時間)がかかるかを計算します。
製品にはかならずリリース日が決まっています。
リリース日までにはマニュアル作成、確認、公開準備の段階があります。
そのため、リリース日から逆算して計画を立てます。
・いつまでにマニュアルを作成しなければいけないのか
・いつまでにマニュアル内容の確認が終わっていなければいけないのか
・いつまでに公開準備が終わっている必要があるのか
案件や会社によって、それぞれ作成、確認、公開の担当者がいる場合もあれば全て同じ人が行なう場合もあります。
いずれにしても「何日までに終わらせなければいけないのか」締め切りを意識して、スケジュールを立てなければいけません。
参考までに私の場合はそれぞれ担当が別々だったので、確認担当者とスケジュールを立てていました。
たいてい１回でOKが出ることはないです。（確認担当者の好みがあるんです。）
そのため、２～３回の修正が入ることを想定して１回目の提出はいつ頃かを伝え、
確認担当者にはいつまでに確認を終えてフィードバックが欲しいかも連絡します。
作成手順３.原稿(マニュアル)の作成・修正
それではいよいよマニュアル作成に入ります。
いざマニュアルを作成していくのですが、
案件や会社によってファイル形式が異なります。
ワード、エクセル、パワーポイント、htmlなどで作成することになります。
既存の機能を微修正や機能を一つ追加、または雛形があれば、マニュアルが既にあるかと思いますので原本に修正を加えていくことになります。
まだファイル形式決まっていない場合や雛形がない場合は、決める必要があります。
製品をバージョンアップする際にマニュアルはメンテナンスが必要です。
今後のメンテナンスを考えたうえで、ファイル形式や公開方法を決めることをおすすめします。
作成手順４.原稿(マニュアル)の確認
マニュアル作成が終わったら、マニュアル内容の確認をします。
上記でもすでにお伝えしましたが、マニュアルの確認に入る場合、
作成者と確認者が同じ場合もあれば別々の場合もあります。
作成者と確認者が同じ場合は次の手順に進んでください。
作成者と確認者が別々の場合は、作成したマニュアルを確認してもらう必要があります。
確認と修正のやりとりは、案件や会社によって異なります。
メールに添付してファイルをやりとりする場合もあれば、指定した保存場所でファイルをやりとりする場合もあります。
または決まっていない場合もあります。
その場合、ファイルを共有で修正できるような保存場所を準備することをおすすめします。
メールでやりとりしているとメールの容量がどんどん増えていったり、
もしも急に他の人が修正したい場合、ファイルを共有する手間がかかります。
ファイルを共有したい人が増えてもいいようにクラウドなどにファイルを保存しておくと手間が省けます。
作成手順５.原稿(マニュアル)の公開
マニュアルの作成と確認が終わったら、いよいよ最後は公開です。
上記でもすでにお伝えしましたが、公開を担当する人が違う場合と作成者と同じ場合があります。
公開担当者が別にいる場合は、連絡します。
参考までに私の場合、作成者である自分自身と公開担当者が別々なので以下の内容を連絡しています。
・修正および追加となったファイル名
・ファイルの保存場所
連絡した後は、公開されるのを待つだけです。
以上でマニュアルの作成、確認、公開までの全体的な流れとなります。
案件や会社によってマニュアル作成の流れは異なりますが、大体の流れは同じかなと思います。
全体的な流れを知っているとどんな知識を必要とするか、
たとえ未経験でマニュアルを作成することになったとしても準備しやすいんじゃないかと。
はじめはマニュアル作成することになって試行錯誤することがありましたが、
慣れてくるとマニュアル作成は楽しくなります。
本記事でマニュアル作成を担当することになって困った！という人が一人でもいなくなれば嬉しいです。
