アプリのマニュアル作成について

得意という程、得意でもありませんけれど「使い方」をWordなどで作成してクライアント様にお渡しする機会は良くあります。

１．そのアプリの全画面をスクリーンショットし、印刷する
アプリがどのようなものであれ、作業手順を第三者に示す為には、そのアプリのスクリーンショットが必要となります。
numa8492さんがアプリに携わっている人ならば、アプリのスクリーンショットを「すべて」撮ることが出来る筈です。
まずは、アプリのスクリーンショットをJpegデータなどで保管し、それを「印刷」してください。
プリンタが自宅に無い場合はコンビニなどでも印刷できますよ。

２．印刷したスクリーンショットを「作業の順番」に並べ替える
慣れてしまえばこの作業は不要ですが、マニュアル作りが初めてなら、印刷したスクリーンショットをテーブルや床などにアプリの挙動順に並べてみてください。
このタイミングでプリントにヌケモレを発見することは多いです。

3．アプリの階層構造を確認する
作業手順「２」の過程で、構造を再確認してください。
例えば「トップ画面から選択肢１～４を選ぶ」「選択肢１を選んだ場合の画面は●●、この画面に遷移した時可能な作業は何か、次に出来る作業は何か」を確認してゆきます。

4．重複する説明は省く
例えばカレンダーアプリが代表的ですけれど、１日と10日を選んでも出来る作業に変わりはありませんね。
大切なのは「機能の説明」であり、重複する説明は省略をする、ということです。

5.「なにができるのか」だけではなく「こんな事をしたいときは」という視点に立つ
マニュアルを作成するときに大事な視点として機能の紹介を中心とした作業手順の紹介となりがちだということです。
スマートフォンでも「アプリの音が消えた！どうすれば」というように「困り事」から探したいということはあると思います。
そのような時に作業手順の紹介だけでは目的の挙動に辿り着かない事もありますね。
ですので目次とは別に索引を制作することで「みとおし」を良くしてあげる必要があると思います。

------

どんなアプリのマニュアルを作成されたいのかによっても異なりますので、一般論として書いてみました。
あとは家電などの取扱説明書を見てみると良いかもしれません。

マニュアルなどのライティングの分野のことをテクニカルライティングといいます。
また、これを専門に行うのがテクニカルライターです。

テクニカルライティングの中でも、マニュアル作成に関しては、文章の書き方、用語用字の使い方、画像のレイアウト等、基本的なフォーマットがあります。

私もテクニカルライターの端くれなのですが、プロに依頼するとけっこう高額になると思います。
テクニカルライティングの教科書的な書籍が出版されていますし、サイトなどもあると思うので、そういうものをいくつか見て勉強されてはいかがでしょうか。

すいません、訂正＆追記です。

先ほどの最後の文章、
そういうものをいくつか見て勉強されてはいかがでしょうか。
→そういうものをいくつか見て勉強しながら、作成されてはいかがでしょうか。

私はIT分野は詳しくないですが、マニュアルの一般的なフォーマットやリライトなら相談に乗れます。

よろしくお願いいたします。