小型ツールを社内へ渡す前に、作った本人のPCだけで成立していないかを確認します。保存先や認証、入力例、失敗時の連絡先が分からないと、利用者は結果が正しいかを判断できません。
利用者が空の状態から始められる説明と設定を用意します。コードやファイルへのアクセス、接続先で実行できる権限、扱うデータの範囲は別に点検します。
共有前の確認表を作る
実データや秘密値を配布物へ混ぜず、設定例には未設定と分かる値を置きます。入力の制約を隠して、どんなファイルでも使えるように案内しません。
| 観点 | 確認する内容 |
|---|---|
| 対象 | 何の業務を行い、何は対象外か |
| 準備 | 必要な環境、設定、利用ユーザー |
| 入力 | 形式、必須列、架空の記入例 |
| 出力 | 保存先、期待する値、確認方法 |
| 権限 | 閲覧、設定変更、実行、外部操作の範囲 |
| 失敗時 | ログ、停止方法、手作業への切替 |
| 保守 | 責任者、連絡先、版、更新日 |
利用者の権限で試す
開発者の管理者権限ではなく、想定する利用者の範囲で、ファイルを開く、入力する、結果を見る作業を確認します。共有先のフォルダから権限が広がっていないかも実際の設定で見ます。
保存先を開けることと、APIを実行できることを分けることが必要です。使うアカウントや認証情報の管理先を示し、秘密値を共有説明へ貼り付けないようにします。
通常の入力だけでなく、空、必須項目不足、権限不足、途中停止の結果も検証用データで確認します。エラーが読めるか、次の確認先が分かるかを利用者の視点で見ます。
共有後の更新と問い合わせを決める
配布する版と更新日を明記し、最新版の場所を決めます。修正内容と適用方法、旧版を使い続けた場合の違いを案内できるようにします。
問い合わせには版、操作、期待した結果、実際の結果、秘密値を除いた記録を付ける形式を用意します。個人情報を含む入力一式の送付を前提にしません。
利用範囲を広げるときは、権限、データ、確認、保守の担当を再点検します。ファイルの共有が済んだことだけで、社内運用が成立したとは判断せず、未確認の項目を残します。
