AIアプリの運用マニュアルには何を書きますか？
日常の操作だけでなく、利用者の追加・停止、更新、費用・ログの確認、問い合わせ、障害時の停止と復旧を書きます。読む人と場面を分け、通常運用、管理者作業、緊急対応を一冊に詰め込みすぎないことも大切です。AIで下書きを作れても、実際の画面と権限で手順を試し、担当者以外が実行できることを確認して完成させます。
操作説明だけでは、運用を引き継げない
ボタンの押し方だけが書かれていても、利用者を追加する人、費用を見る人、止まったときに判断する人が分からなければ会社の仕組みにはなりません。マニュアルは、作った本人が不在でも仕事を続けるための運用設計です。
利用者向け、管理者向け、障害対応を分けると、必要な人が必要な情報を見つけやすくなります。
最初に、役割と連絡先を書く
サービス責任者、日常の問い合わせ先、技術担当、費用確認者、公開・停止の承認者を記載します。外部サービスを利用する場合は、契約者、管理画面、サポート窓口の所在も残します。
個人名だけでは異動で古くなるため、役割名と引き継ぎ方法を併記します。パスワードやAPIキーそのものはマニュアルへ書きません。
通常、変更、障害の三つに分ける
通常運用にはログイン、入力、結果の確認、問い合わせを記載します。変更手順には、テスト環境での確認、承認、本番反映、元へ戻す方法を書きます。障害対応には、影響確認、停止、連絡、復旧、再開判定を記載します。
費用とログをいつ誰が確認するか、バックアップと復旧を最後に試した日も、運用記録として残します。
AIの下書きは、実画面で検証する
AIは仕様や操作記録から手順書を整理できますが、存在しないボタンや古い画面をもっともらしく書くことがあります。実際の権限を持つテスト用アカウントで、手順を最初から実行します。
管理者だけに見える操作を一般利用者向けへ書かない、秘密情報を画面例へ含めない、スクリーンショットの個人情報を隠す、といった確認も必要です。
変更した日に、マニュアルも変える
アプリを更新したのにマニュアルが古いままでは、誤操作の原因になります。変更の完了条件に、該当する手順、画面、連絡先、更新日、確認者の見直しを含めます。
まず、作った本人以外の一人へマニュアルを渡し、説明なしで日常操作と問い合わせ先を見つけられるか試してください。迷った箇所が最初の改善点です。
出典・参考情報
情報は最終更新時点の内容です。サービスの仕様・料金・利用条件は公式情報をご確認ください。