Documentazione per l'utente è troppo spesso scritto da programmatori per programmatori. Esso tende a concentrarsi sulle caratteristiche del prodotto, piuttosto che le attività dell'utente. In generale, i programmatori non sono nella posizione ideale per scrivere documentazione per l'utente. They're troppo vicino ai bit e byte ed essi sono troppo lontano da parte dell'utente. A loro, che cosa può fare il prodotto tende ad essere molto più importante di ciò che l'utente può fare con il prodotto.
Essa è una distinzione sottile ma vitale. La ricerca mostra che la chiave per la documentazione per l'utente efficace è la scrittura di aiuto attività orientata. Meglio ancora, scrivere il vostro aiuto secondo la teoria minimalista. Al mondo della documentazione, "minimalismo" è una parola di fantasia per una pratica di senso comune. In termini di base, esso significa scrivere al vostro lettore e mantenerlo semplice.
La teoria stessa ha un sacco di colpi di scena e si trasforma. Se si desidera leggere un libro grande ma un po' prolisso sull'argomento, check out il libro "Minimalismo Beyond the Nurnberg imbuto", 1998, a cura di John Carroll.
Nel frattempo, se si può spuntare a ogni elemento la seguente lista di controllo, sarete bene sul vostro modo di guida in linea utilizzabile che sia i tuoi lettori e i gestori verranno ringrazio per.
Utile guida Checklist
1. L'aiuto di base su compiti reali (o esempi realistici)
2. Strutturare l'aiuto in base alla sequenza di attività – rubriche capitolo dovrebbero essere obiettivi e argomenti dovrebbero essere i compiti.
3. Attività del lettore di rispettare-questo è generalmente più su cosa non fare rispetto a quello che fai. Non perdete tempo del lettore tuffandosi in tangenti.
4. Valorizzare la preventiva conoscenza ed esperienza – attirare l'attenzione del lettore precedente attività, esperienze, successi e fallimenti.
5. Evitare gli errori-"garantire voi fare x prima di fare y"
6. Rilevare e identificare gli errori - "Se questa operazione fallisce, potrebbe aver inserito il percorso in modo errato"
7. Correggere errori - "Re-inserire il percorso"
8. Fornire informazioni di errore alla fine dei compiti ove necessario (regola, un errore info nota a tre attività è una buona media).
9. Non rompere le istruzioni con le note, le avvertenze, avvisi, e casi eccezionali - mettere queste cose alla fine dell'istruzione, ove possibile.
10. Essere breve, non sillabare fuori tutto, soprattutto le cose che possono essere dato per scontato
11. Omettere concettuale e nota informazioni, ove possibile, o un link ad esso. Forse fornire informazioni di espansione alla fine del tema, più forse una nota che ci sono altri modi per eseguire il compito/gol, ma questo è il modo più semplice.
12. Sezioni dovrebbero essere breve e lettura breve
13. Fornire chiusura per sezioni (ad esempio, torna a schermo/obiettivo originale)
14. Fornire un'occasione immediata ad agire e a incoraggiare l'esplorazione e l'innovazione (uso attivi inviti ad per agire, ad esempio, "Vedere per te …" o "Provare questo …" piuttosto che inviti passivi come ad esempio, "può...")
15. Convincere gli utenti a avviarlo rapidamente
16. Consentire per la lettura in qualsiasi ordine - semplificare ogni sezione modulare, specialmente gli obiettivi, ma forse le attività (sicuramente se essi possono essere eseguite in ordine diverso)
17. Evidenziare le cose che non sono tipiche
18. Utilizzare la voce attiva anziché passiva
19. Provare tenere conto di ambiente dell'utente nella tua scrittura
20. Prima di scrivere qualsiasi cosa, chiediti "Questo aiuterà il mio lettore?"
Con la costruzione di queste pratiche nel vostro processo di documentazione, troverete che il vostro aiuto on-linea diventa più facile scrivere, più breve e molto più utilizzabile per il lettore. In più, tuo capo ti amerà!
No comments:
Post a Comment