見出し画像

CMSのマニュアルを制作する際に意識すべきこと5選!


はじめに

先日、初めてCMS(WordPress)のマニュアルを1から作成しました。
参考マニュアルはあったものの1から作るとなると、考えるべきことが多く、非常に時間がかかりました。。
しかしさまざまな方からアドバイスをいただき、とっても良いマニュアルを作ることができました!
そのアドバイスや自分が意識したポイントを、自分の備忘録として、同じような状況にいる方の参考として、役に立てば良いなと思い解説します!
最後まで読んでいただけると嬉しいです。

では早速5つのポイントを解説します!

1.全体の構成を先に考える

マニュアルに限らずnoteでも文章をまとめる時に一貫して言えることですが、頭から思いつくままに作成し始めてしまうと、自分の頭の中で完全に内容をまとめられていない限り、内容が重複したり流れがおかしくなってしまいます。
全体の流れの項目とその項目に記載することを箇条書きで書き出してから、実際のマニュアルの作成を行いましょう。

2.IT初心者をイメージして作成する

実際に説明を記載していく前の大切な心持ちとして、作成したマニュアルを使用するのは、主にそのCMSを使用したことがない人、もしくは使い慣れていない人です。

CMSって何?という状態の人が使う可能性も高いと思います。
(実際私も仕事で使うまでCMSがなにか、全く知りませんでした。)
専門的な用語や使用者の中での通語を使用してしまうと、初心者だと意味がわからず、理解に時間がかかってしまうでしょう。
心持ちとしては「IT系の知識がまったくない友達や家族に説明する用の資料を作成している!」という意識で作成すると、自ずとわかりやすいマニュアルへと近づきます。

ITの知識がないお母さんに説明するつもりで!

3.使用する語句を統一する

とは言っても、どうしても専門用語を使わずを得ない部分も発生するかと思います。
その際、専門用語を初めて使用した時に注釈を加えたら、基本的には2回目以降は注釈を入れる必要はないと思います。

しかし、2回目以降は注釈がない代わりに、1回目と全く同じ言葉を使用するということが非常に重要です。

またこれは、専門用語以外の言葉も同じです。
例えば、このnoteの中で「CMSの~」と話していますが、同じ意味の意図で「WordPressの~」と話し始めたら同じことを指しているのか、違うものの話をしているのか。
もしくはWordPressってなに?という状況が生まれてしまいますよね。

また、専門用語以外でも「クリック」「押下」「押す」「進む」など同じ意味に使える複数の言葉があります。
これらを混ぜてしまうと統一感がないものになってしまい、読む人によっては違う解釈をしてしまうことも考えられます。

そのため、同じ意味で使用する言葉については、最初から最後まで同じ言葉を使用するようにしましょう。

4.最低限のフォーマットを使用する

PowerPointなどのスライドでマニュアルを作成する際は必ずデザインフォーマットを使うようにしましょう。

デザインフォーマットがないと文字や画像の配置など全部調整しないといけなくなるため、非常に時間がかかります。

マニュアルは凝ったデザインを施す必要はありません。必要な情報がきちんと伝われば良いのでデザインフォーマットを探す際は、「いかにシンプルか」を重視するのがオススメです。

シンプルなフォーマットのオススメサイトはこちら(無料)↓
canva
https://.canva.com/ja_jp/presentations/templates/simple/

5.画像を多く使う

ここで「マニュアルを使うのは、CMSを使ったことがない人」という前提を思い出してください。
文章のみだと、言葉の解釈の違いが発生してしまい、その言葉がどこを指しているのかわからないという状況が起こります。

どんなことでも使い方を説明するときは、実際に画面を見せながら説明するのが直感的にも理解ができ、間違いが起きにくいですよね。

ここで注意してもらいたいのが、管理画面などをスクショして説明するときに、
「そのスクショの画面、、どこを開いたら出る画面??」
という状況にならないようにすることです。

画面をスクショするときは、
全体を映す、もしくは全体→部分的にクローズアップ
という流れなるようにすると非常にわかりやすいマニュアルになります。

まとめ

マニュアル制作に一番重要なのは「利用する人に意図が伝わるか」です。
いくら画像を多く使用していても、説明の文が論文のような説明書きだと読みにくいですよね。
そうならないためのミニポイントとして、接続詞をあまり使わないようにするのもオススメです。

以上、マニュアル制作のポイントについて解説しました。いかがでしたでしょうか?
マニュアル作成は、製品やサービスの利用者にとって重要なツールです。記事で紹介したポイントを活用し、わかりやすく役立つマニュアルを作成してみてください。

マニュアルの質が向上すれば、利用者の満足度も高まり、新人への引き継ぎもスマートにでき効率化にも繋がります。ぜひ実践してみてください!

この記事が気に入ったらサポートをしてみませんか?