Auditorユーザーガイドの構成と規約

axe Auditor製品のユーザーインターフェース（UI）は、アクセシビリティ専門家の手動アクセシビリティテストのニーズを満たすために丹念に設計されており、このユーザー文書セットも同様の構成です。ユーザーリサーチと評価、アンケート、ユーザーストーリー、一般的に行われる使用ケースシナリオに基づき、弊社の専門家たちはこの2年間で、クライアントのウェブサイトで使用するアクセシビリティテスト、問題の優先順位付け、レポート作成プロセスを洗練させ、The Deque Wayのアクセシビリティテストおよび関連するガイド付きアクセシビリティテストツールであるaxe Auditorを確立し精緻化してきました。したがって、このガイドの目次はUIそのものと同じくらい直感的であり、アプリケーションの使用において非常に便利な伴侶となります。

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

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

新しいプロジェクトを最初から始める場合でも、進行中の既存のプロジェクトに戻る場合でも、この文書を親しみやすい参照として使用するのが直感的であることがわかるでしょう。そのため、新しいビルドや複数のブラウザでテストを再実行したり、要件が満たされていることを確認したり、開発者向けに正確で一貫性のあるアクセシビリティ問題のレポートを作成したり、管理者向けに包括的なレポートを作成したりする場合でも、普通行われないタスクの「操作方法」情報を見つけることが、axe Auditorでテストを再開するのと同じくらい簡単です。そして、検索、コンテンツ、索引、パンくずリスト、相互参照リンクにより、必要な情報を迅速に入手できます。

• 規約 本書で使用されているものは、対象読者にとって本質的に理解しやすいと思われますが、以下に簡単に説明されています。この文書はスタイルフォーマットを一貫して使用し、スキャンしやすくしています。含まれているものは以下の通りです：

• 構造：このページの前半で述べたように、この文書セットの構造は一般的にユーザーインターフェースを左右、上下から読むようにするもので、情報が必要な場所に冗長性なしで提供されることを目指しています。

• タイトルと見出し：手順のタイトルは通常、続く情報を明確に示す見出しにおいて動名詞で始まります。

• 注意、メモ、重要：タスクの完了に必要な事前条件、概念的、または補足情報を提供する注意喚起は、丸い角の枠に囲まれた色付きの背景として表示され、それに注意を引くようになっています。

• テキストフォーマット：本書セットでは、 太字 （強調スタイル）をフォーマットとして使用し、「クリック可能」なユーザーインターフェース要素（ボタンなど）や、それらを紹介する際の導入的なフレーズを明確に示しています。

• サンプル入力：整形済みコードスニペットや例は、必要に応じた適切なインデントと行間隔を提供するために、ハイライトされ、または適切にフォーマットされることがあります。通常、 Courier Newのようなフォントを使用します。

• グラフィカル画像：スクリーンショットは説明目的でのみ使用されますが、可能であれば実際の選択データや実例を反映しています。このようなグラフィックは、サポートしているテキストの近くに配置され、代替テキストが提供されます。

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