非エンジニアの開発アシスタントが、アプリ操作マニュアルを作るポイントをまとめました

この記事の目的

アプリ操作マニュアルの作成ポイントを抑える
アプリ操作マニュアルの構成を知る

この記事を執筆した背景

自社開発企業で開発アシスタントとして働いており、
現在までアプリ操作マニュアルを作成する業務を任されています。

「アプリの操作マニュアルなんて、何を気をつけて作ったらいいの？」と、
当時調べていましが、プレゼン資料などの提案資料や業務マニュアルのノウハウが多くヒットしましたが、
アプリ操作マニュアルの作成ポイントがピンポイントに理解できる内容が見つけられませんでした。

以上のような経緯から、十数種以上のアプリ操作マニュアルを作成した自身の経験をもとに、
アプリ操作マニュアル作成にあたり、気をつけるべきポイントをわかるような記事をまとめてみました。

誰向けの記事か

・アプリ操作マニュアルを作っている人
・ベンチャー企業でアプリ開発をしていて、マニュアルを今後作成する必要がある人

アプリ操作マニュアル作成のヒント

1. マニュアル閲覧者のペルソナの理解

マニュアルを閲覧する人のペルソナを理解しましょう。

例えば、業務系アプリの場合だと、情報システム部の方になるでしょう。
ただ、実際にそのアプリを使用するのは、現場社員の方だったりします。
現場に運用を任せるために、システム・アプリを利用するメンバーを管理する人がマニュアルを閲覧することも十分有り得るパターンです。
システムの仕組みを詳しくご存知ない方や、パソコンがうまく扱えないなどの情報リテラシーがある方ばかりではないので、できるだけ平易な言葉を使ったり、画像やアイコンなどを利用して視覚的にわかりやすい表現をすることをお勧めします。
開発メンバーが作り上げた機能を、わかりやすくエンドユーザーに届ける架け橋を意識してみるといいかもしれません。

2. マニュアルの目的

さて、マニュアルの目的とはなんでしょうか。
操作者がアプリを使用できるようになるためでしょうか？
そうだとしたら、直接、アプリ開発担当者や、カスタマーサポートに聞いて説明を受ければ
その目的は達成できますよね。

しかし、そうした場合、当然ですが
会社の電話は鳴りっぱなしで他の業務が出来ませんよね。

マニュアルの真の目的は、
カスタマーサポートに問い合わせなくても、操作者が自ら操作できるようになると言えるのではないでしょうか。


3. マニュアルの構成例

1. 表紙
   アプリのどんな機能についての操作マニュアルか明記しましょう。

2. 目次
   読者の方も経験があるかと思いますが、通読してマニュアルを閲覧することは、あまり多くないでしょう。目次を頼りに、欲しい情報を探しに行きます。必ず目次を用意して、リンクを貼って「閲覧者の欲しい情報」へアクセスできる導線を作ってあげましょう。

3. 機能、操作の概要
   「1.マニュアル閲覧者のペルソナを理解しよう」にも関わりますが、
   説明する操作の概要や流れ、機能を利用するのに条件がある場合は
   事前に、絵や図を利用して説明することをお勧めします。
   ・この操作で何ができるのか
   ・この機能を利用するには、どんな前提条件があるのか
   以上に触れていると、これ以降の詳細な手順が理解しやすくなります。
   引用元：cyzen内線機能マニュアル

4. 操作手順の説明
   具体的な操作説明になります。ここでは、以下をポイントにすると良いでしょう。
   ・実際のアプリ画面の画像を利用する
   ・短文での説明にする
   ・１ページに一操作に留めて簡潔にする
   
   引用元：トークルームで検索をする【LINE Labs】

5. ユースケース
   こちらは、必須ではないですが、
   私は「この機能はどういったユースケースで利用されそうか」を事前に検討して、記載しておきました。
   理由としては、様々な機能があるアプリの場合、目次だけでは、欲しい情報に辿り着けないと思ったため、「用途例」というページを作って、それぞれ用途にあった操作へリンクへ飛べるようにしました。
   
   引用元：cyzen新ユーザー管理画面操作マニュアル

6. FAQ
   こちらでは想定できる質問と回答を用意します。
   「2.マニュアルの目的」にも関わりますが、マニュアル内で不明点を解消できるようにします。
   もし思いつかない場合は、似た機能をもつ既存アプリのマニュアルを参考にしていました。

7. 裏表紙
   サービス提供元や問い合わせ先を載せましょう。
   マニュアルを読んでも、どうしても理解できないということも大いにありますので、
   カスタマーサポート等の担当者連絡先も添えてあげます。

備考1：事前準備

参考までに、私がマニュアルを作成する前に用意していたこと、準備していたことを記載しておきます。

1. マニュアル作成ソフト：PowerPoint
2. キャプチャツール：Macのキャプチャ機能、またはVysor（スマホ画面をPC画面に表示できます）
3. マニュアル用環境：チームに相談の上、用意します（キャプチャを撮っても問題ないアカウント）
4. スケジュール：おおよそのFIX時期を確認
5. マニュアル内容：新リリース内容、新サービス内容または機能のアップデート内容
6. 操作手順の理解

備考2：作成スケジュール

1. 構成案作成
2. 上長確認（構成案）
3. 構成案を元に、マニュアルの作成
4. セルフチェック、全体を通してフレッシュな目で見てみる
5. 上長確認（マニュアル）
6. 修正①
7. カスタマーサポートへの確認
8. 修正②
9. FIX（公開作業も含む）

終わりに

新しい機能や、アップデートされたアプリなど、都度追記・編集が求められるのがマニュアル作りです。マニュアル管理という観点からも、上述の構成を意識した作りにしておかないと、
「今回リニューアルした画面をマニュアルに反映したいけど、どのマニュアルに使用していたっけ？」、「どのマニュアルを参考にすればいい？」といったことにもなり得ます。
操作者に優しいマニュアルは、マニュアル管理者＝マニュアル作成者にとっても優しいのかもしれません。

あくまで、今回の記事は一例として紹介しました。
参考になりましたら、幸いです。