A11yDocs マニュアル アクセシビリティ検査スイート利用マニュアル

アクセシビリティ検査スイート利用マニュアル

このディレクトリは、アクセシビリティ検査スイート一式を利用する人向けのマニュアルです。

アクセシビリティ検査スイートは次の3つで構成されます。

名称役割
ライセンス認証アクセシビリティ検査記録簿 / アクセシビリティ検査員 共通のライセンス認証
アクセシビリティ検査記録簿アクセシビリティ試験の方針、対象ページ、試験結果、公開用Markdownを記録する管理画面
アクセシビリティ検査員ログイン中の公開ページ上で動作するアクセシビリティ検査パネル

読む順番

初めて利用する場合は、次の順番で読んでください。

  1. 購入の手順
  2. ライセンスの適用手順
  3. アクセシビリティ検査記録簿の試験の進め方
  4. アクセシビリティ検査員の検査の進め方

このマニュアルの前提

画面名の表記

管理画面のURLは環境によって bid が変わります。本文では画面名を中心に説明し、必要な場合だけURL例を載せます。

画面URL例
ライセンス認証/bid/1/admin/app_mszm_a11ysuite_license/
アクセシビリティ検査記録簿/bid/1/admin/app_mszm_a11yflow_index/
アクセシビリティ検査員設定/bid/1/admin/app_mszm_a11yinspector_index/

作業全体の流れ

購入・ライセンス発行
  ↓
ライセンス認証で認証
  ↓
アクセシビリティ検査記録簿で試験方針と対象ページを決める
  ↓
アクセシビリティ検査員で公開ページを検査する
  ↓
アクセシビリティ検査記録簿に結果を記録する
  ↓
試験結果 Markdown とスナップショットを保存する

用語

用語意味
ライセンスキー発行元から受け取る認証用の文字列。利用者はこれをライセンス認証に入力する
対象ドメインライセンスで利用を許可するドメイン。例: example.com
複数サイト可ライセンス1つのライセンスキーで複数ドメインを登録できるライセンス
試験対象ページアクセシビリティ検査記録簿で試験対象として確定したページ
達成基準WCAG / JIS X 8341-3 の各確認項目。例: 1.1.1 非テキストコンテンツ
共通項目サイト全体に共通して判断できる達成基準。ページ別では編集不可になる
スナップショット試験完了時点の記録をJSONとして固定保存したもの