GUI変更の退行防止チェックリスト¶
常設コントロールを減らす変更は、結果領域が広がり、同じ作業を引き続き見つけやすい場合に
だけ有効です。internal/server/web/、GUI操作の配置、ショートカット、セットアップ/
結果レイアウトを変更するすべてのPull Requestで、このチェックリストを使います。
Pull Requestテンプレートからこの文書へリンクし、確認証拠を変更と一緒に残します。
変更前の基準を作る¶
変更前後で、ビューポート、言語、比較モード、サンプル結果を同じにします。影響を受ける 各作業について、操作経路とポインター操作回数を記録します。メニューや開示の展開、 項目の選択、ダイアログの確定はそれぞれ1操作です。既に見えているコントロールへの フォーカスや入力は数えません。
| 常用作業 | 必須結果 |
|---|---|
| 最初の比較を実行 | 変更前より操作回数を増やさない |
| 現在の比較を再実行 | 再比較を常に直接表示し、1クリックで実行できる |
| 片側の入力パスを変更 | 変更前より操作回数を増やさない |
| 空白の扱いを変更 | 変更前より操作回数を増やさない |
| 次の差分へ移動 | 変更前より操作回数を増やさない |
| 左右表示 / 統合表示を切り替え | 変更前より操作回数を増やさない |
| 編集したペインを保存 | ペイン直接編集の導入後は1クリックで実行できる |
変更範囲外の作業は、再計測の代わりに変更なしと記録します。issueが意図的に経路を
変更する場合は、変更前後の回数と、新しい経路が製品目標を満たす理由を記録します。
必須確認¶
- 頻繁な操作への到達性を保つ。 Compare/再比較は常に1クリックで実行できる状態を 保ちます。ペイン直接編集の導入後は、保存も1クリックで実行できる状態を保ちます。
- 常用作業のクリック数を増やさない。 影響を受ける作業について上の表を完成させます。 頻繁な操作をメニューへ移し、操作を1回増やすことは退行です。
- キーボードだけで操作する。 変更・追加したすべてのコントロールへTab/Shift+Tab または文書化されたショートカットで到達し、Enter/Spaceで実行します。一時UIを Escapeで閉じ、フォーカスが有用な場所へ戻ることも確認します。ポインター専用の 経路は不可です。
- 削減した領域を結果へ渡す。 セットアップやツールバーを縮めた場合は、変更前後の 結果ペイン寸法を比較します。空いた領域を未使用の空白にせず、結果表示を広げます。
- 通常DPIと高DPIを確認する。 最低でも100%と200%スケール(またはdevice pixel ratio 1と2)で確認します。アイコンを判別でき、コントロールが重ならず、アクティブ/ フォーカス状態が見える必要があります。
- 文書化した到達経路を保つ。 設定や操作を移動した場合は、 GUI設定の到達可能性と配置方針を更新します。 スクリーンショットなしで検証できる安定した経路、ショートカット、レイアウト不変条件には 自動テストを追加または更新します。
Pull Requestに残す証拠¶
Pull RequestのGUI退行確認欄で、次を行います。
- GUIに影響しない変更であることを示すか、該当する項目をすべて完了する
- 変化した作業について、変更前後のクリック数を記載する
- 実行したキーボード経路を記載する
- 視覚確認に使ったビューポートとスケールを記載する
- 配置、アイコン寸法、結果領域の拡張が大きく変わった場合は、スクリーンショットまたは 短い録画へのリンクを記載する
レビュアーは、新しい状態のスクリーンショットだけでGUIレイアウト変更を承認しません。 頻繁な作業が難しくなっていないことを証拠で確認します。