Scrivendo aiuto utile – una lista di controllo di minimalism

Scrivendo aiuto utile – una lista di controllo di minimalism

La documentazione di utente è tutta scritta troppo spesso dai programmatori per i programmatori. Tende a mettere a fuoco sulle caratteristiche del prodotto, piuttosto che le mansioni dell’utente. Generalmente, i programmatori non sono nella posizione ideale da essere documentazione di utente di scrittura. Sono troppo vicini ai bit ed ai byte e sono ugualmente lontano dall’utente. A loro, che cosa il prodotto può fare tende ad essere molto più importante di che cosa l’utente può fare con il prodotto.

È – ma vitale – una distinzione sottile. La ricerca indica che la chiave alla documentazione di efficace utente sta scrivendo l’aiuto orientato in funzione delle mansioni. Anche migliorare, scrivere il vostro aiuto secondo la teoria minimalista. Nel mondo della documentazione, “il minimalism„ è una parola operata per una pratica buon senso. Nei termini di base, significa scrive al vostro lettore e lo mantiene semplice.

La teoria in se ha molte torsioni e girate. Se volete leggere un grande – ma un po’wordy – prenotare sull’oggetto, verificano il libro “minimalism oltre l’imbuto del nurnberg„, 1998, pubblicato dal carroll del john.

Nel frattempo, se potete fare tic tac ogni articolo nella seguente lista di controllo, sarete bene sul vostro senso ad aiuto in linea utilizzabile che sia i vostri lettori che i vostri responsabili lo ringrazieranno per.

Lista di controllo utile di aiuto

1. basare l’aiuto sui compiti reali (o sugli esempi realistici)

2. strutturare l’aiuto basato sulla sequenza di operazione – le intestazioni di capitolo dovrebbero essere obiettivi ed i soggetti dovrebbero essere mansioni

3. rispettare l’attività del lettore – questo è generalmente più circa che cosa non fate che che cosa fate. Non sprecare il tempo del lettore tuffandosi fuori nelle tangenti

4. sfruttare la conoscenza anteriore e sperimentare – attirare l’attenzione del lettore sulle mansioni, sulle esperienze, sui successi e sui guasti precedenti

5. impedire gli errori – “accertar che facciate la x prima di fare y„

6. rilevare ed identificare gli errori – “se questo viene a mancare, potete entrare in modo errato nel percorso„

7. errori di difficoltà – “registrare di nuovo il percorso„

8. fornire l’errore Info alla conclusione delle mansioni se necessario (regola empirica, una nota di errore Info per tre mansioni è una buona media)

9. non rompere in su le istruzioni con le note, le avvertenze, gli avvertimenti ed i casi eccezionali – mettere queste cose alla conclusione dell’istruzione, ove possibile

10. essere riassunto, non ortografano tutto fuori, particolarmente cose che possono essere prese per assegnato

11. omettere concettuale e notare le informazioni nel possibile, o il collegamento ad esso. Forse fornire informazioni di espansione alla conclusione del soggetto, più forse una nota che ci sono altri sensi effettuare l’operazione/obiettivo, ma questo è il più facile

12. sezioni dovrebbero osservare il bicchierino e leggere il bicchierino

13. forniscono la chiusura per le sezioni (per esempio, di nuovo allo schermo originale/obiettivo)

14. forniscono un’occasione immediata comportarsi ed incoraggiare l’esplorazione e l’innovazione (gli inviti attivi di uso a comportarsi, come, “vedono per lei…„ o “provare questo…„ piuttosto che gli inviti passivi come, “voi potere… “)

15. ottengono gli utenti iniziati rapidamente

16. tengono conto la lettura in tutto l’ordine – rendere ogni sezione modulare, particolarmente obiettivi, ma forse incaricato (definitivamente se possono essere effettuate nell’ordine differente)

17. cose di punto culminante che non sono tipiche

. voce attiva di uso 18 piuttosto che voce passiva

. prova 19 per rappresentare la situazione di utilizzo nella vostra scrittura

20. prima di scrittura qualche cosa, si chiedono che “questo aiuto il mio lettore?„

Sviluppando queste pratiche nel vostro processo della documentazione, troverete che il vostro aiuto in linea diventa più facile da scrivere, più breve e molto più utilizzabile per il vostro lettore. Che cosa è più, la vostra sporgenza lo amerà!