新入社員に向けてマニュアル書いてる人も多いと思いますが、内容の記述方法、気をつけている点あればこちらに集積したいと思います。
例えば、
“「レイヤー」メニューから「新規調整レイヤー」の「ベタ塗り」を選択して〜”
のように、極力「アプリの表記に従う」「どうすれば望む操作になるのか」がはっきりするように記述しています。
慣れていれば「ベタ塗りレイヤーを追加します」みたいな書き方でもわかりますが、「どうしたらそのレイヤーを追加できるのか」に関してはソフトを初めて操作する場合はなかなかわからないので…
少し文章自体は長くなってしまいますが「どこ？どこでレイヤーを追加するんだ！」になるよりはいいかなと。
「いいね！」 1
OJT前提だとキモになるポイント等、口頭で指示すればいいや…となってすっ飛ばしがちになったりしますよね。
ただ、居なくても分かるように……とステップを踏んでキャプチャ付きで書いているものでも、これくらい分かるだろう、分れよ、的な暗黙の前提があって実はそのマニュアルだけでは操作不可、ってことも結構あるし、辛いですよな
数年間作り続ける製品のためにインクジェットプリントの作業手順書を作成したことがあります。
先方の製品開発のグループとの共同作業だったので、形を整える部分はほとんどやってもらう形になってしまいましたが、やはり肝心のオペレーションについては我々が頑張るしかなく、大変勉強になりました。
ということで、そのあたりを振り返りながら、思いついたモノをいくつか挙げてみます。
常に状態をチェックする
assertをいっぱい入れる、という感じです。
期待する状態を図や写真で提示し、判定するための条件を数値と説明文で多数記載しました。
条件が適切に設定されていると、少ない負担で確実に異常をトラップできるので、オペレーションしやすく信頼性の高いマニュアルに仕上がります。品質を作り込むキモかもしれません。
一般的なマニュアルにおいても、理解の程度を図るためのチェック項目や練習問題を設定するのではないかと思いますが、なかなかちゃんとやってくれないのではないかなーと思います。なぜそう思うかというと、私がそういうのを飛ばすタイプだからですw
まとめて確認するのではなく、なるべくその場で理解が正しいことを判断できるよう、こまめにチェックする仕掛けを入れるよう工夫しています。
知恵比べ、楽しいよね
前述の内容と関連しますが、読者の反応を予測し、いかに理解を促し、間違った解釈が起きないように作り込むか、というチャレンジと考えて取り組んでいます。これはなかなかに挑み甲斐のある、ある意味非常に楽しい作業です。
結果を知ることができないと対応できないので、マニュアルを作成したあと、いかにしてフィードバックを得るか、というのが難しいところです。
TL;DR
要約・要点を先に書いておく、というのは、ぜひやっておくべきではないかと思います。
これをやると容易にわかった気になるので、ビジネス書やセミナーで悪用されているフシもありますが、そこをちゃんと理解に導くのも腕の見せ所。長い説明の前に、脳が情報を受け取りやすい状態にしておこう、という狙いです。
以上、とりあえずいくつか思いつくモノを書いてみました。
手順的な文書ものを作る、という意味ではこんなところだろか。
- モレなくダブリなく
- 手順としては簡潔に
- 重要な内容（やってはダメとか絶対やるとか）は確実に書く
- どうでもいいところはできるだけ省略とか書かないようにする
口頭でフォローすることは勿論するんですけど、大事な部分だけは明文化する。
ただし「大事だけどこれは覚えさせる」ものは、手で書かせるような措置も併用することも。
資料があると意外に覚えないことがあるので（読んで覚えた気になってしまう）。
いずれにしても、目的その他も個々のケースで変わるので、絶対これに沿う、というのはないかもしれない。