Come scrivere un manuale utente per Software

January 9

Come scrivere un manuale utente per Software


Il manuale utente del software è importante quasi quanto il software stesso. Il manuale utente è di vitale importanza per l'apprendimento di entrambe le tecniche di base e più avanzate di un programma o un'applicazione. Manuali sono tipicamente breve, ma se è necessario più dettagliatamente, essi possono essere molto più lungo. La lunghezza di un manuale dipenderà esclusivamente dal tipo di software e quanto dettaglio deve includere. Gli utenti apprezzeranno manuali con facile da trovare, informazioni concise, con sufficiente dettaglio per evitare confusione.

istruzione

1 Scrivi uno schema per il manuale. Questo vi darà un piano da seguire.
Cose da includere nello schema sono la procedura di installazione, lo scopo del software, le descrizioni dei menu, le operazioni più comuni, funzioni avanzate, e una sezione di risoluzione dei problemi. Includere anche sottosezioni nel vostro profilo per compiti specifici, come ad esempio la creazione di un nuovo file, il salvataggio dei file, e la stampa di file.

2 Particolare il processo di installazione, inclusi i requisiti del computer. Fornire requisiti prima la procedura di installazione principale modo che gli utenti possono preparare i loro computer.
Includere anche i passaggi più elementari per i principianti del computer. Questi passaggi possono includere "doppio clic sul file di installazione" o "inserire il CD nel lettore CD-ROM."
procedura di installazione tipiche coinvolgono spiegare le opzioni di installazione, come ad esempio una tipica installazione rispetto a un'installazione avanzata, camminando l'utente passo-passo attraverso ogni schermata GUI che incontrano, registrando il software e inserendo i 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. Includere ciò che un utente ha bisogno il software per e come possono trarre beneficio. Per esempio, se il software si occupa di contabilità, spiegare operazioni contabili comuni che il software rende più facile. Spiegare quali funzioni sono i più importanti per l'utente finale. Questo darà all'utente un'idea di che funziona per cercare di imparare prima. Per esempio, nel software di creazione musicale, dire all'utente su come molte tracce possono essere registrate in una sola volta, qualunque inclusi suoni e ritmi, ei formati dei file possono essere salvati in.
Includere una breve descrizione delle caratteristiche avanzate che rende questo software diverso dagli altri presenti 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. Spiega ogni voce nei menu previsti. Tutti gli elementi che non possono essere spiegati in una o due frasi dovrebbero essere inclusi nella sezione Attività comuni del manuale. Queste attività potrebbero includere cambiare font e colori, stampa in diversi formati e tipi di file, e organizzare i file e le informazioni.

5 Scrivi una sezione separata per le funzioni avanzate e caratteristiche extra. Questo è il posto dove andare nei dettagli. Per esempio, un manuale utente per Microsoft Excel potrebbe includere informazioni sulla creazione di relazioni, legami e macro.
Le caratteristiche supplementari includeranno funzioni l'utente finale non può aspettare. Per esempio, software di creazione musicale può venire fornito con un lettore musicale. Prendetevi il tempo per spiegare extra che possono venire con il software, o usi uniche del software.

6 Fornire suggerimenti per la risoluzione. Spiegare il significato di eventuali errori l'utente potrebbe incontrare, come risolvere il problema, e come prevenirlo in futuro. Questo è anche il luogo per includere contatti e help desk informazioni.