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

