監査ツーザーガイドの構成と慣例

axe Auditor製品のユーザーインターフェイス（UI）は、アクセシビリティ専門家の手動アクセシビリティテストのニーズを満たすように慎重に設計されているため、このユーザー文書セットも同様の方法で構成されています。ユーザー調査と評価、アンケート、ユーザーストーリー、一般的なユースケースシナリオに基づき、私たちの専門家は過去2年間、クライアントのウェブサイトで使用するアクセシビリティテスト、問題の優先順位付け、レポート作成プロセスを洗練させ、The Deque Wayとその関連するガイド付きアクセシビリティテスティングツール、axe Auditorを確立し改良してきました。従って、このガイドの目次もUI自体と同様に直感的であり、アプリケーションを使用する際の便利な伴侶として役立ちます。

axe Auditorユーザーインターフェイスのトップメインメニューとクイックページリンクです。

このユーザーガイド内の左側のサイドバーコンテンツメニューとページ内のクイックページリンクです。

新しいプロジェクトを開始する場合でも、進行中の既存プロジェクトに戻る場合でも、この文書が馴染みのある参考資料として直感的に使用できることが分かります。そのため、新しいビルドや複数のブラウザでテストを再実行し、要件が満たされていることを確認し、開発者向けに正確で一貫性のあるアクセシビリティ問題のレポートを作成したり、経営陣向けの包括的なレポートを作成する場合でも、頻繁に行われないタスクの「ハウツー」情報を見つけるのは、axe Auditor自体でのテストランを中断したところから再開するのと同じくらい簡単であり、検索、コンテンツ、索引、パンくずリスト、クロスリファレンスリンクが素早く必要な情報を得る手助けをします。

• 慣例 がこの文書に使用されており、対象読者にとって本質的に理解しやすいと考えられていますが、以下で簡単に説明されています。この文書はスタイル形式の一貫した使用を採用しており、スキャンしやすくしています。それらには次のものが含まれます：

• 構造：このページで先に述べたように、この文書セットの構造は全般的にユーザーインターフェイスに似ており、左から右へ、上から下へと読み進めるときに、冗長性なく必要な情報を提供することを目指しています。

• タイトルと見出し：手順のタイトルは通常、後に続く情報を明確に識別するために見出しで動名詞で始まります。

• 注意、注意事項、重要：タスクの完了に必要な前提条件、概念的または補足的な情報を提供する警告が、丸みを帯びたコーナーの枠内に囲まれたカラーバックグラウンドでノートとして表示され、注意を引きます。

• 文字形式：この文書セットでは次の文字体裁の慣例を使用します 太字 （強調スタイル）は、手順の指示における「クリック可能な」ユーザーインターフェイス要素（例えばボタン）を明確に識別するため、またはそれらを紹介するための表現として使用されます。

• サンプル入力：整形済みのコードスニペットと例は、必要に応じてハイライトされたり、適切に書式設定され、必要に応じて適切なインデントと行間隔を提供します。通常、オフセットフォント（例えば Courier New）を使用します。

• 画像：スクリーンショットは、デモンストレーション用にのみ使用されますが、可能な場合、実際の選択データと実際の入力例を反映しています。そのようなグラフィックは、関連するテキストの近くに配置され、代替テキストが提供されています。

ドキュメントへの直接フィードバック：このドキュメントセットに関する読者からのフィードバックは、最も貴重な入力の1つであり、常に歓迎されます！このユーザーガイド（およびオンラインヘルプシステム）に関するフィードバックをいつでも送信するには、axe Auditorアプリケーションのユーザーインターフェイス内の一般的なフィードバックフォーム、以下の一般的なヘルプデスクの連絡先情報を使用するか、 axe-auditor-feedback@deque.comに電子メールを送信することができます。