Linee guida per la creazione di pagine di aiuto
Le pagine di aiuto e le pagine di aiuto miste consentono a un utente di raggiungere un obiettivo completando una sequenza di operazioni. Queste istruzioni indicano quando utilizzare le pagine di aiuto esistenti e quando scrivere una nuova pagina di aiuto.
Quando creare pagine di aiuto
Cheat sheets are well suited to tasks which consist of steps which lead
towards a tangible goal, such as building a simple application. L'obiettivo deve essere ben definito in modo che l'utente possa visualizzarlo una volta completate tutte le operazioni riportate nella pagina di aiuto. Le esercitazioni sono spesso buoni candidati per le pagine di aiuto in quanto in una esercitazione lo scopo è imparare ad eseguire una determinata attività. Le pagine di aiuto di solito non contengono più di 10 operazioni e possono essere completate mediante in mezzora.
Per attività più consistenti, utilizzare una pagina di aiuto mista.
Quando creare pagine di aiuto miste
Le pagine di aiuto miste sono utilizzate per fornire le istruzioni relative a un'attività troppo lunga per essere descritta in una pagina di aiuto semplice o che ha più obiettivi. Una pagina di aiuto mista può essere utilizzata per descrivere una sequenza di attività ognuna delle quali si basa sull'attività precedente.
Quando non utilizzare pagine di aiuto
Le pagine di aiuto sono utili quando il problema può essere risolto da una sequenza di operazioni semplici. Tali pagine non sono un sostituto del sistema della guida che consente la creazione di pagine HTML con grafici e informazioni che utilizzano funzioni di ricerca e collegamenti ipertestuali. Le pagine di aiuto non sono adatte per le attività che richiedono una notevole immissione di testo da parte dell'utente.
Istruzioni per la creazione di una pagina di aiuto
- Scegliere un titolo breve ma significativo.
- Quando possibile, utilizzare i link al sistema della guida presenti nelle attività della pagina di aiuto per fornire informazioni di base o dettagliate.
- Scrivere una pagina di aiuto mista se è necessario eseguire più di 10 operazioni.
- Quando possibile, utilizzare gli appositi comandi per eseguire attività quali l'apertura delle prospettive, l'apertura delle risorse o l'esecuzione di procedure guidate. Assicurarsi inoltre di fornire una descrizione di come ottenere lo stesso risultato senza utilizzare il comando.
- Verificare che sia possibile ignorare i comandi nel caso in cui l'utente decidesse di eseguire le operazioni manualmente.
- Specificare dialog="true" per le operazioni che aprono finestre di dialogo. In questo modo la pagina di aiuto verrà aperta in un "cassetto" sulla destra nella maggior parte delle finestre.
- Organizzare le operazioni in modo che l'utente possa sempre visualizzare segnali di successo. Una pagina di aiuto che apporta un numero di modifiche al codice java e quindi avvia un'applicazione può essere riscritta in modo che l'applicazione venga riavviata in seguito a ogni modifica del codice sorgente.
- Verificare che l'utente comprenda il motivo per cui viene eseguita una determinata operazione.
- Invece che descrivere più modi per eseguire un'operazione selezionare il modo più semplice che richiede una descrizione minima.
- Utilizzare tag break (<br/>) per una migliore leggibilità.
- È possibile utilizzare elementi secondari per suddividere delle operazioni lunghe in operazioni più piccole.
- Non tutte le pagine di aiuto richiedono elementi secondari.
- Iniziare il testo dell'etichetta dell'elemento secondario con parole come "Input", "Espandere",
"Selezionare", ecc. ecc.
- Per le etichette di elementi secondari, identificare chiaramente il testo dell'interfaccia utilizzando le virgolette in modo da consentire agli utenti di differenziare il testo delle istruzioni dal testo dell'interfaccia che devono individuare e utilizzare.
- Ogni elemento secondario deve essere responsabile di una attività come ad esempio l'immissione di un valore.
- Aggiungere sempre un elemento <onCompletion> all'ultima operazione di una pagina di aiuto.
- Test cheat sheets with different sizes for the cheat sheet view.
- Test cheat sheets with the error log view open so you can see if any
warnings are written to the log.
Istruzioni per la creazione di una pagina di aiuto mista
- Una pagina di aiuto mista deve contenere attività che sono relative a un tema comune.
- Ogni attività all'interno di una pagina di aiuto mista deve avere un obiettivo ben definito.
- Utilizzare gli elementi <onCompletion> per riconoscere un corretto completamento.
- I nomi delle attività devono essere brevi e concisi.
- I problemi complessi possono essere risolti utilizzando attività che si basano sulle attività precedenti.
- Utilizzare skip="true" se un'attività è facoltativa.
- Per una maggiore coerenza, verificare che l'introduzione alla pagina di aiuto semplice e il nome corrispondano all'introduzione e al nome specificati nella pagina di aiuto mista.
- Per le descrizioni delle attività, identificare chiaramente il testo dell'interfaccia utilizzando una formattazione in grassetto.
- Sequenze precise vanno utilizzate soltanto quando è necessario imporre un ordine di avvio delle attività.
Related links
Utilizzo delle pagine di aiuto
Working with composite cheat sheets
Simple cheat sheets
Composite cheat sheets