Manuale utente di axe Auditor: Organizzazione e convenzioni

Poiché l'interfaccia utente (IU) del prodotto axe Auditor è stata attentamente progettata per soddisfare le esigenze di test di accessibilità manuale degli specialisti dell'accessibilità, questo set di documentazione utente è organizzato in modo molto simile. Sulla base di ricerche e valutazioni degli utenti, sondaggi, storie degli utenti e scenari di casi d'uso comunemente eseguiti, i nostri esperti hanno trascorso gli ultimi due anni a perfezionare il processo di test di accessibilità, definizione delle priorità dei problemi e creazione di report che utilizziamo sui siti web dei nostri clienti per stabilire e perfezionare il metodo Deque per i test di accessibilità e il relativo strumento di test di accessibilità guidato, axe Auditor. Per questo motivo, l'indice di questa guida è intuitivo tanto quanto l'interfaccia utente stessa, rendendolo ancora più comodo da usare come complemento all'applicazione.

Il menu principale in alto e i collegamenti rapidi alle pagine nell'interfaccia utente di axe Auditor.

Il menu dei contenuti della barra laterale sinistra e i collegamenti rapidi alle pagine all'interno di questa guida per l'utente.

Che tu stia iniziando da zero con un nuovo progetto o che tu stia riprendendo uno già in corso, troverai intuitivo utilizzare questa documentazione come riferimento familiare. Pertanto, se si stanno rieseguendo test su nuove build e più browser, verificando che i requisiti siano stati soddisfatti, creando report precisi e coerenti sui problemi di accessibilità per gli sviluppatori o creando report completi per la direzione, trovare le giuste informazioni "come fare" per le attività meno comunemente eseguite sarà facile come riprendere da dove si era interrotto un test in axe Auditor stesso, e la ricerca, i contenuti, l'indice, il breadcrumb e i collegamenti di riferimento incrociato ti aiuteranno a ottenere rapidamente ciò di cui hai bisogno.

• Le convenzioni utilizzate nel presente documento sono intrinsecamente comprensibili per il pubblico a cui sono destinate; tuttavia, vengono brevemente spiegate di seguito. Questa documentazione adotta un uso coerente della formattazione dello stile per facilitarne la consultazione. Essi includono:

• Struttura: come accennato in precedenza in questa pagina, la struttura di questa documentazione rispecchia generalmente l'interfaccia utente, ovvero si legge da sinistra a destra, dall'alto verso il basso, e cerca di rendere le informazioni disponibili dove servono senza ridondanza.

• Titoli e intestazioni: i titoli delle procedure in genere iniziano con un gerundio nelle intestazioni che identificano chiaramente le informazioni che seguono.

• Attenzione, Nota, Importante: gli avvisi come quelli che forniscono informazioni preliminari, concettuali o supplementari necessarie per il completamento di un'attività vengono visualizzati come note su sfondi colorati racchiusi in bordi arrotondati per richiamare la tua attenzione.

• Formattazione del testo: questa documentazione utilizza la convenzione tipografica del grassetto (stile forte) come formattazione per identificare chiaramente gli elementi "cliccabili" dell'interfaccia utente, come i pulsanti nelle istruzioni procedurali, o come frasi introduttive per introdurli.

• Input di esempio: frammenti di codice e esempi preformattati sono soggetti a evidenziazione e/o formattazione appropriati per fornire l'indentazione e la spaziatura delle righe adeguate, ove necessario. In genere verrà utilizzato un font in contrasto come Courier New.

• Immagini grafiche: gli screenshot vengono utilizzati solo a scopo dimostrativo, ma, quando possibile, riflettono i dati di selezione effettivi e gli esempi di partecipazione reali. Tali elementi grafici vengono posizionati vicino al testo che supportano e sono dotati di testo alternativo.

Feedback diretto sulla documentazione: il feedback del pubblico (lettori) su questa documentazione, indipendentemente dal ruolo dell'utente finale, è uno dei contributi più preziosi che riceviamo e è sempre ben accetto! Per inviare commenti e suggerimenti su questa guida per l'utente (e sul sistema di assistenza online) in qualsiasi momento, è possibile utilizzare il modulo di feedback generale presente nell'interfaccia utente dell'applicazione Axe Auditor, le informazioni di contatto generali dell'help desk riportate di seguito oppure inviare un'e-mail a axe-auditor-feedback@deque.com.