Progettazione di un sistema di aiuto

Question

Sto implementando un sistema di guida per un'app desktop (Win32) e sto cercando di capire come progettarla.

Che tipo di struttura dovrebbe avere un sistema di aiuto, cosa è effettivamente utile per l'utente? per esempio.Il sistema della guida dovrebbe essere un lungo elenco di domande frequenti (la guida di Office 2010 sembra essere così)?o dovrebbe essere un elenco di caratteristiche che documenta e descrive cosa fa ogni cosa (questo è probabilmente utile solo se l'utente non è sicuro di come funzioni una caratteristica che già conosce)

Che tipo di conoscenza devo aspettarmi che abbia l'utente finale?Probabilmente è leggermente umiliante scrivere nel file della guida che File -> Open Project Chiude il progetto corrente (se presente) e apre un progetto esistente.

Quello che sto cercando qui sono alcune indicazioni, un insieme di funzionalità che qualsiasi buon sistema di aiuto dovrebbe avere e un metodo per organizzare gli argomenti in modo che gli utenti possano trovarli.

Answer 1

"Progetto aperto" può anche essere un buon punto in cui inserire un riferimento alla definizione di un progetto e altre descrizioni e procedure più generali relative all'apertura dei progetti.

In generale si accede all'help di CHM tramite l'aiuto sensibile al contesto (che è il tipico per il caso file-> aperto) e tramite l'indice generale, la ricerca a testo completo e gli indici. Le app più recenti sembrano creare solo una pagina della guida per contenitore (un dialogo o un menu a scomparsa), dove elencano tutti gli elementi su quella schermata (ad esempio tramite screenshot annotati) e non un lemma per ogni elemento (casella di controllo, voce di menu) in la GUI. Meno confusione e navigazione e molti punti richiedono solo una descrizione abbastanza breve

Oltre alla guida sensibile al contesto, è anche possibile sfogliare la guida tramite il sistema di aiuto.

Un CHM è più o meno come un e-book, con un sommario (TOC), un indice e, facoltativamente, il supporto per la ricerca a testo completo.

L'indice e la ricerca full-text sono modi per l'utente di cercare contenuti. La differenza principale è che l'indice è più sotto il tuo controllo e la ricerca full-text è in gran parte automatica quando abilitata.

Il TOC è una visualizzazione ad albero dei nodi che agiscono come il TOC in un libro e dovrebbe fissare la struttura generale dell '"ebook". Le domande frequenti sono in genere un'appendice di questo sommario.

Oltre a questo, c'è una pagina di "ingresso" predefinita, che è come la home page di un sito web. Dovrebbe indirizzare gli utenti agli argomenti cercati più comunemente.

Fai attenzione confrontando i prodotti Microsoft. A volte utilizzano sistemi che non sono ancora disponibili per gli utenti finali / sviluppatori.

Un buon aiuto utilizza tutti questi elementi.

Answer 2

Esistono sostanzialmente due stili di aiuto: basato sui riferimenti (ad es. cosa significa questa casella di controllo?) e basato sulle attività (come ottengo XYZ?).

Probabilmente è meglio creare prima un tutorial basato su attività, supportato da una FAQ se necessario.