監査ユーザーガイドの構成と規約
axe Auditor 製品のユーザーインターフェース(UI)は、アクセシビリティ専門家の手動アクティビティテストのニーズを満たすために慎重に設計されています。このユーザー文書セットも同様の方法で構成されています。ユーザー調査と評価、調査、ユーザーストーリー、一般的に行われる使用ケースシナリオに基づき、我々の専門家たちは、過去2年間で、ウェブサイトのアクセシビリティテスト、問題の優先順位付け、レポート作成プロセスを改良してきました。これにより、The Deque Wayのアクセシビリティテストと、その関連ガイド付きアクセシビリティテストツールであるaxe Auditorの確立と改良を行っています。そのため、本ガイドの目次もUIと同様に直感的であり、アプリケーションを使用する際の便利な伴侶となります。
axe Auditorのユーザーインターフェースにおけるトップメインメニューとクイックページリンク。
このユーザーガイド内の左サイドバーコンテンツメニューとページ内のクイックページリンク。
新しいプロジェクトから始めるにしても、進行中の既存のプロジェクトに戻るにしても、この文書を親しみやすい参考として直感的に使えることがわかるでしょう。新しいビルドや複数のブラウザでテストを再実行する際、要件が満たされていることを確認する際、開発者向けに正確かつ一貫したアクセシビリティ問題のレポートを作成する際、および管理向けの包括的なレポートを作成する際に、あまり一般的でないタスクの「やり方」情報を見つけるのも、axe Auditor自体のテスト実行の途中から再開するのと同様に簡単です。そして、検索、コンテンツ、索引、パンくずリスト、クロスリファレンスリンクを通じて、必要な情報を迅速に得ることができます。
-
規約 本文書に使用されているものは、対象の読者にとって本質的に理解しやすいと考えられていますが、以下に簡単に説明されています。この文書は、一貫したスタイルのフォーマッティングを採用しているため、スキャンしやすくなっています。それらには次のものが含まれます:
-
構成:このページで前述したように、この文書セットの構成は、一般的にUIと同様に、左から右、上から下に読み進めるように構成され、情報が必要な場所に提供されるように、冗長性をなくしています。
-
タイトルと見出し:手順のタイトルは一般的に動名詞で始まり、その後に続く情報を明確に特定する見出しを持っています。
-
注意、注、重要:タスクの完了に必要な前提条件、概念情報、補足情報を提供するアラートは、あなたの注意を引くために、丸みを帯びた角の枠内の色付き背景として表示されます。
-
テキストフォーマッティング:この文書セットでは、 太字 (強調スタイル)という組版上の慣習を使用して、手順の指示内の「クリック可能な」ユーザーインターフェース要素、またはそれらを導入する冒頭のフレーズを明確に識別します。
-
サンプル入力:整形済みコードスニペットや例は、必要に応じて適切な字下げや行間を提供できるように、強調表示やフォーマットが施されています。通常、
Courier Newなど、差し引きフォントを使用します。 -
グラフィカルイメージ:スクリーンショットはデモンストレーション目的のみで使用されますが、可能な限り、実際の選択データや実際のエントリーの例を反映するようにしています。これらのグラフィックは、対応するテキストの近くに配置され、代替テキストを付けています。
直接的な文書フィードバック:この文書セットに対する読者(オーディエンス)のフィードバックは、エンドユーザーロールにかかわらず、私たちが受け取る最も貴重なインプットの一つであり、常に歓迎されます。このユーザーガイド(およびオンラインヘルプシステム)へのフィードバックをいつでも送信するには、axe Auditorアプリケーションのユーザーインターフェース内の一般的なフィードバックフォーム、以下の一般的なヘルプデスクの連絡先情報、または axe-auditor-feedback@deque.comにメールを送ってください。

