La documentazione utente include gli screenshot? [duplicare]

Gli screenshot sono un aspetto importante della guida dell'utente. Tuttavia, devono anche essere accompagnati da istruzioni chiare e precise. Ad esempio, avendo uno screenshot che mostra lo schermo, una freccia rossa che punta a un pulsante e il testo che legge "Ora che hai inserito il nome del file, fai clic sul pulsante Avanti ". è molto più chiaro del testo o dello screenshot da solo.

Fare buone guide click-click richiede molto tempo, ma ne vale la pena quando si tratta di supportare gli utenti finali (anche tecnici)

Il vecchio adagio "un'immagine da mille parole" è raramente importante quanto lo è qui. Per favore, per favore, per favore, per il tuo bene e per i tuoi utenti: USARE MOLTI SCREENSHOT.

Essendo stato in una situazione simile, in cui la maggior parte dei miei utenti erano donne anziane, non sono in grado di comunicare l'utilità degli screenshot. La domanda diventa, come presentarli. Ho trovato che un approccio basato su attività funziona meglio.

per es.

Indice dei contenuti

1. Informazioni sul cliente
   • Voglio aggiornare l'indirizzo di un cliente
2. Fatturazione
   • Voglio creare una fattura per un cliente
   • Voglio creare una fattura per un cliente
3. Spedizione
   • Hai un'idea

Si noti che ogni intestazione nel TOC è ovviamente un collegamento (che qualsiasi formato, sia esso word / html / chm / qualsiasi cosa supporti). Quindi per ogni singola azione (ad esempio 1.1) inizia con la prima schermata che l'app mostra quando si apre.

1. Inizia dalla schermata Home
   • [screenshot]
2. Fai clic su "Clienti"
   • [screenshot con un grande cerchio rosso attorno al pulsante "Clienti"]
3. Si arriva alla finestra Clienti
   • [screenshot della finestra dei clienti]
   • (nota, usa una build di test con solo clienti fasulli)
4. Fai clic su "Cerca"
   • [screenshot con un grande cerchio rosso attorno al pulsante "Cerca"]
5. Inserisci il cognome del cliente e fai doppio clic il loro nome
   • [schermata della finestra di ricerca con il cognome del cliente nella casella di ricerca]
6. Si arriva alla schermata dei dettagli del cliente
   • [screenshot dei dettagli del cliente]
7. Fai clic su "Modifica"

ecc.

Sì, questi primi passi sono ridondanti e il tutto è molto laborioso. Gli utenti si abitueranno semplicemente a sfogliare la prima o due pagine, ma chiunque e tutti, il loro primo giorno di lavoro o dopo una lunga vacanza, o congedo, o congedo per malattia, o qualsiasi altra cosa ... può essere detto a " Vai a fare [questo] "quindi fai clic su" Voglio fare [questo] "nei documenti e avere istruzioni dettagliate che mostrano esattamente cosa fare.

Puoi fare in modo che il primo passaggio sia "Apri il file del cliente" che è collegato alla sezione "Voglio vedere le informazioni di un cliente". Siate cauti, sono passato a questo e ho avuto una grande parte dei miei utenti che lo hanno trovato estremamente complicato. Quelli che non lo trovavano complicato, non gliene importava abbastanza di apprezzare la "scorciatoia". Il suggerimento è: Conosci il tuo pubblico e non presumere nulla su di loro .

C'è un vecchio articolo di Joel Spolsky (che, per la vita di me, non riesco a trovare) in cui parla dell'usabilità e delle barre di assistenza alle carrozzelle nei bagni. Il punto cruciale dell'argomento era che alcune caratteristiche di usabilità non sono necessarie per tutti ... ma quando sono disponibili, tutti le usano e le apprezzano. Sono fermamente convinto che la documentazione incredibilmente ovvia per le app interne rientri in questa categoria. Soprattutto se si considera che non è possibile cercare assistenza online.

Dipende dalla tua applicazione precisa e da come è strutturata, ma in generale dovresti avere più testo rispetto alle schermate che ho trovato. A meno che il tuo prodotto non sia la prima introduzione di un utente a un computer, non dovresti preoccuparti delle istruzioni click-by-click. Supponendo che la tua interfaccia utente sia sana, dovresti essere in grado di descrivere come eseguire la maggior parte delle operazioni con il testo e forse con alcuni screenshot.

Se la tua interfaccia utente non è abbastanza sana e / o fuorviante .. beh, potresti risolvere il problema oppure puoi fornire schermate o persino GIF animate che mostrano come far funzionare effettivamente il tuo prodotto. Dovresti fornire questo oltre a un sacco di testo in chiaro.

Gli utenti potrebbero essere essi stessi programmatori / tecnici, la descrizione precisa con solo pochi screenshot dovrebbe essere sufficiente.

Ma se gli utenti sono persone non tecnologiche, gli screenshot con descrizioni precise aiuteranno molto. Tieni presente che molte persone non sono nemmeno a conoscenza dei termini tecnologici che probabilmente stai utilizzando nella descrizione. Prova a chiedere a qualsiasi persona che utilizza un computer quale sia il pulsante di opzione.

In conclusione: dipende dagli utenti