AI駆動開発

社内ツールを引き渡すときに説明すること

執筆:Dignowa編集部公開:更新:読む目安:約1分

小さな一画面のツールでも、担当者が変われば、使えるデータや保存先が分からなくなります。説明書に残す内容は規模でなく、使う人が何を判断するかから選びます。

入力条件と、困ったときの作業

特定CSVの集計なら、列、単位、期間、使えない資料を示します。ファイルを選べることと、その形式に対応することは別です。確認済みの入出力見本も残せますが、社内で共有できるものを使い、個人情報を余分に複製しません。

エラー後は再実行、元データ修正、管理者への連絡を分けます。外部登録の状態が不明なら、登録先を確認する手順も必要です。何度も押し直す説明にはしません。

アカウント、保存先、変更する担当

誰の権限でどのサービスが動き、データがどこに残るかを記録します。退職後も会社で管理できるよう、認証情報は説明書へ平文で載せず、会社の保管・受け渡し方法を使います。説明書の閲覧と設定変更の権限も分けます。

項目追加の依頼先、保守に含む範囲、別料金の変更、停止時の連絡先を決めます。作成者が不在の設定変更も合わせて、使う条件と対処が分かる資料を残してください。