操作手順を仕事と結び付ける
操作説明は、ボタンの一覧だけでは十分でないことがあります。どの仕事で使うのか、入力の前に何を用意するのか、出力した後に何を確認するのかを整理すると、利用者が実際の場面に置き換えやすくなります。
説明する対象者と必要な資料を確認し、画面の例や手順の範囲を決めます。すべての案件で同じ分量のマニュアルが付くわけではありません。担当者が変わることを想定する場合は、初回の設定と日常の操作を分けた説明も検討できます。
設定と環境を一覧にする
OS、必要なソフトウェア、保存先、アクセス権など、動作に関係する条件を整理します。設定を変更するときは、どこまでが利用者の操作で、どこから相談が必要なのかを分けておくと、問題を避けやすくなります。
端末の入替えやOSの更新がある場合、以前の環境と違う点を確認してください。機器の管理者と実際の利用者が別であれば、両者に必要な情報を分けます。環境の一覧は、すべての将来の変更に対応できる保証ではなく、相談や調査の基準になります。
不具合の連絡に必要な材料
問題が起きたときは、実行した操作、入力の種類、表示された内容、起きた時刻を整理してください。「動かない」という説明だけより、どこまで動き、どこで止まったかが分かると確認しやすくなります。
画面の画像や処理の記録を共有する場合、個人情報や秘密が含まれていないかを確認します。必要な資料の範囲と渡し方は、個別に相談してください。問題が外部サービスや端末の条件に関係する場合、別の管理者による確認が必要になることもあります。
保守と改修を分ける
不具合への対応、環境の変化への対応、新しい機能の追加は、同じ作業ではありません。保守に含める範囲、連絡の方法、追加作業の判断を、事前に整理します。開発費用に、無期限ですべての変更への対応が含まれると想定しないでください。
業務の流れが変わった場合は、変更したい画面だけでなく、入出力や担当する人の違いを説明してください。小さな変更に見えても、データの持ち方や確認の範囲が変わることがあります。影響を整理してから、対応の可否と条件を相談します。
利用者側の準備も確認する
端末の管理、データのバックアップ、利用者への周知など、利用者側で担当する仕事があります。実際の運用に入る前に、誰が確認し、問題が起きたら誰へ連絡するかを共有してください。
資料の更新や版の管理を誰が行うかも、引き継ぎの一部です。必要な成果物と役割を、案件ごとに明らかにします。相談の段階から運用する人の事情を教えていただくと、開発と引き継ぎの範囲を一緒に整理できます。
