LoginSignup
1
0

マニュアル作成 失敗例備忘録

Posted at

私が所属しているチームは、メンバーの入れ替わりが激しいです。
新規メンバーアサインの度にレクチャが必要ですが、レクチャするための資料がなかったりまとまっていなかったりすると色々と問題が起きます。
いろんなところからメモを引っ張り出す必要があり時間を要したり、断片的に伝える形になって相手に伝わりにくくなったり、と不都合が起きるため、日々メンバーでマニュアル整備を行なっています。

今回はマニュアル作成においてよくある失敗例について、備忘のためまとめました。

誰からみても明らかな名称を使っていない

テキストフィールドの名称やクリックするボタン・タブの名称など、実際のUIに使われているテキストを用いていないことがあります。例えば、実際には「キャンセル」ボタンなのに「削除」ボタンとマニュアルに書いてしまうとか。これをやると書いた人にはわかるけど他の人には伝わらないマニュアルになりがちなので注意しています。

全体概要がわからず何を説明されているかわからない

上手い説明の仕方として、全体像を説明してから詳細の説明をすると伝わりやすい、と聞いたことがあるかもしれません。マニュアルも同じで、全体像がわからないまま詳細だけ書かれていても理解しにくい資料になってしまいます。冒頭に全体像を説明する資料を入れるとか、個々のタスクのマニュアルにこれは全体像におけるどの部分なのかを示す図を入れてあげるとかすると、わかりやすくなります。大きな業務フローの中の1つのタスクのレクチャをする場合、アサイン直後の人にとっては全体像を完全に理解していないこともあるので、全体像におけるどの部分のタスクか冒頭で説明すると、点と点がつながりやすくなります。

作業の目的がわからない

目的理解が浅いと、作業の必要性を軽視し、手順を無視、その結果作業ミスが起きるという事態が引き起こされます。レクチャの際に口頭で説明するだけだと受ける側が忘れてしまう懸念が高く、レクチャをする側も説明し忘れる可能性があります。マニュアルに作業目的を盛り込むことは少ないかもしれませんが、入れておくといいことのほうが多いと思っています。

さいごに

浅学ながら、備忘のためマニュアル作成における失敗例をまとめました。
テクニカルライティングの知識をつけて再編集したいと思います。
乱文失礼いたしました。お読みいただきありがとうございました。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0