Nwlapcug.com


Come scrivere un manuale utente per il Software

Come scrivere un manuale utente per il Software


Il manuale utente per il software è quasi altrettanto importante quanto il software stesso. Manuale dell'utente è fondamentale per l'apprendimento delle tecniche di base e più avanzate di un programma o applicazione. I manuali sono in genere brevi, ma se è necessario più in dettaglio, possono essere molto più lungo. La lunghezza di un manuale dipenderà esclusivamente il tipo di software e deve includere la quantità di dettagli. Gli utenti potranno apprezzare manuali con facile da trovare, informazioni concise, con sufficiente dettaglio per evitare confusione.

Istruzioni

1

Scrivere una struttura per il manuale. Questo vi darà un piano da seguire.
Cose da includere all'interno della struttura sono la procedura di installazione, software scopo, descrizione dei menu, attività comuni, funzioni avanzate e una sezione di risoluzione dei problemi. Nella struttura per attività specifiche, ad esempio creando un nuovo file, salvataggio di file e stampa di file includono sotto-sezioni.

2

Dettaglio il processo di installazione, compresi i requisiti del computer. Fornire requisiti prima della procedura di installazione principale, così gli utenti possono preparare loro computer.
Includono anche i passaggi più elementari per i principianti del computer. Questi passaggi possono includere "doppio clic sul file di installazione" o "inserire il CD nell'apposita unità."
Installazione tipica passaggi comportano spiegando le opzioni di installazione, ad esempio un'installazione tipica contro un'installazione avanzata, a piedi l'utente passo dopo passo attraverso ogni schermata GUI che incontrano, registrazione del software e inserendo eventuali codici o numeri di serie, e come accedere al programma una volta installato per verificare la corretta installazione.

3

Fornire una descrizione dettagliata dello scopo del software. Sono quello che un utente ha bisogno del software per e come essi possono trarre beneficio. Per esempio, se il software si occupa di contabilità, spiegare attività comuni di contabilità che il software rende più facile. Spiegare quali funzioni sono più importanti per l'utente finale. Questo darà all'utente un'idea di quali funzioni per cercare di imparare per primo. Per esempio, nel software di creazione musicale, dire l'utente circa il numero di tracce può essere registrato in una sola volta, qualsiasi inclusi suoni e ritmi e i formati di file possono essere salvati in.
Includere una breve descrizione delle funzionalità avanzate che rende questo software diverso dagli altri sul mercato. Per esempio, il software può essere in grado di generare più rapporti o supporta più tipi di file di qualsiasi altro programma attualmente disponibile.

4

Spiegare come navigare nei menu. Spiegare ogni elemento nei menu fornito. Tutti gli elementi che non possono essere spiegati in una o due frasi dovrebbero essere incluso nella sezione attività comuni del manuale. Queste attività potrebbero includere modificare font e colori, stampa su diversi formati e tipi di file e organizzare file e informazioni.

5

Scrivere una sezione separata per le funzioni avanzate e funzioni extra. Questo è il posto dove andare nel dettaglio. Per esempio, un manuale utente per Microsoft Excel potrebbe includere informazioni sulla creazione di rapporti, collegamenti e macro.
Caratteristiche supplementari comprendono funzioni che l'utente finale non può aspettarsi. Per esempio, il software di creazione musicale può venire in bundle con un lettore musicale. Prendetevi il tempo per spiegare extra che può venire con il software, o unico utilizza del software.

6

Fornire suggerimenti sulla risoluzione dei problemi. Spiegare il significato di eventuali errori, che l'utente potrebbe incontrare, come risolvere il problema e come prevenirlo in futuro. Questo è anche il posto di includere il contatto e la reception informazioni.