Sebbene spesso ignorati da molti utenti di computer, i file della guida forniscono informazioni chiave su come utilizzare l'applicazione software a cui sono associati. Facendo clic su "Aiuto", un utente può ottenere una panoramica delle funzionalità del programma, una descrizione della schermata che sta guardando, istruzioni su come utilizzare il programma per eseguire una determinata attività o leggere elenchi di domande frequenti sul programma e le relative risposte. La scrittura di un file della guida richiede sia la capacità di lavorare con le applicazioni software sia la capacità di spiegare le cose in un modo comprensibile agli utenti.
Passi
Passaggio 1. Procurati una copia del software che devi documentare
Se possibile, dovresti anche ottenere una copia delle specifiche scritte per il programma, anche se non tutti gli sviluppatori di software lavorano con loro. In alcuni casi, il programmatore devierà dalle specifiche, in base a tempi di sviluppo brevi o non essendo in grado di codificare una particolare funzionalità.
Passaggio 2. Ottenere uno strumento di creazione della guida
Sebbene sia possibile creare manualmente un file di aiuto, utilizzando un file in formato RTF (.rtf), la maggior parte degli autori di file di aiuto utilizza un'applicazione software per scrivere i propri file di aiuto, come RoboHelp, Help and Manual, Doc-To -Aiuto, MadCap Flare o HelpLogix. La maggior parte degli strumenti di creazione della guida include un editor di testo o funziona con un programma di elaborazione testi come Microsoft Word e fornisce un'interfaccia utente che consente all'autore della guida di vedere come apparirà il file della guida mentre lo scrive mentre scrive il codice del computer dietro le quinte per far funzionare il file di aiuto. Alcuni strumenti di creazione della guida includono anche editor grafici per la creazione di schermate da includere nel file della guida.
Esistono numerosi formati di file della guida: il più comune è la Guida HTML, utilizzata dalle applicazioni eseguite in Windows. (Un formato più vecchio, WinHelp, non è più supportato.) Anche Apple e Unix hanno i propri formati, così come Sun Microsystems, con il suo JavaHelp. Le applicazioni software progettate per essere eseguite con diversi sistemi operativi possono utilizzare un sistema di guida multipiattaforma che viene eseguito nel browser Web dell'utente. Qualunque sia lo strumento di creazione di aiuto che usi dovrebbe supportare il formato o i formati di aiuto in cui creerai i file di aiuto
Passaggio 3. Creare il file del progetto di aiuto
Il tuo strumento di creazione della guida creerà per te un file di progetto della guida, in base al nome del file fornito e ad altre informazioni. Il file di progetto principale contiene informazioni sugli altri file, che includono un file di contenuti, un file di indice, uno o più file di immagine e altri file.
- Il file dei contenuti include il testo nel file della guida che spiega come funziona l'applicazione software che stai documentando. Il testo è solitamente suddiviso in argomenti che coprono una schermata, una funzione o una procedura specifica.
- Il file indice è un elenco degli argomenti del file della guida. Viene utilizzato per creare un sommario che gli utenti possono utilizzare per selezionare un argomento da visualizzare, nonché un indice ricercabile all'interno del file della guida.
- I file di immagine sono file grafici di schermate di programma o parti di tali schermate visualizzate all'interno del file della guida per migliorare la capacità degli utenti di comprendere a cosa si riferisce il testo del file della guida.
Passaggio 4. Regolare le dimensioni della finestra della guida
A meno che tu non stia scrivendo il file della guida in modo che venga visualizzato nel browser Web dell'utente, il file della guida verrà visualizzato nella sua finestra. Il tuo strumento di creazione della guida ti consentirà di regolare le dimensioni orizzontali e verticali della finestra a una dimensione che consentirà all'utente finale di leggere il file della guida senza intralciare l'applicazione stessa. La finestra principale della guida è spesso in un formato a tre riquadri, con il sommario a sinistra e l'argomento selezionato a destra.
I file della Guida possono anche avere, oltre alla finestra principale, finestre secondarie che descrivono in dettaglio una particolare funzionalità e finestre pop-up di ridimensionamento automatico che forniscono brevi descrizioni delle funzionalità. I file della guida possono anche includere testo incorporato che appare solo quando si fa clic sul testo evidenziato o su un pulsante
Passaggio 5. Scrivi gli argomenti della guida
Per fare ciò, dovrai rivedere le specifiche o il programma stesso per creare gli argomenti per documentare le schermate e le funzionalità del programma. Quando crei ogni argomento, lo strumento di creazione della guida lo aggiungerà al sommario e all'indice del file della guida.
- Sebbene tu possa costruire il sommario mentre procedi, è utile avere un piano su come organizzarlo. È possibile organizzare il sommario attorno alle schermate del programma, alle sue caratteristiche, ai modi di utilizzarlo oa una combinazione di questi.
- Mentre scrivi gli argomenti, considera altre informazioni nel file della guida a cui gli utenti vorranno avere accesso rapido. È possibile creare salti o collegamenti ipertestuali nel testo del file della guida che si collegano agli argomenti che contengono tali informazioni.
Passaggio 6. Includi screenshot, se necessario
Molte funzionalità del programma vengono spiegate al meglio con una combinazione di testo e grafica. Puoi creare schermate con l'applicazione fornita con lo strumento di creazione della guida o con un'applicazione separata, come Microsoft Paint, Paint Shop Pro o SnagIt.
- Il testo e gli screenshot dovrebbero essere disposti insieme in un argomento in modo che gli utenti possano vedere lo screenshot e il suo testo di supporto senza dover scorrere inutilmente. In molti casi, vorrai mostrare una parte della schermata di un programma anziché l'intero schermo o mostrare lo screenshot in una dimensione più piccola dell'originale. La tua applicazione per screenshot dovrebbe essere in grado di ridimensionare lo screenshot senza sfocature o perdita di dettagli.
- Se prevedi modifiche all'interfaccia utente tra la versione di prova e quella finale del programma, potresti voler sospendere la creazione di schermate finché non avrai la versione finale del programma con cui lavorare.
Passaggio 7. Creare un file mappa, se necessario
Alcuni programmi includono i pulsanti "Guida" per consentire a un utente di fare clic e visualizzare l'argomento nel file della guida che descrive in modo specifico come funziona quella schermata. La visualizzazione di un argomento in questo modo è chiamata guida sensibile al contesto e richiede la creazione di un file mappa per consentire al programmatore di collegare il pulsante "Aiuto" all'argomento specifico nel file della guida. Il tuo strumento di creazione della guida può crearne uno per te, oppure il programmatore può codificarlo e dartelo da includere nel file della guida.
Passaggio 8. Compila il file della guida
La compilazione crea il file della guida effettivo che verrà incluso con il programma. Per la maggior parte dei formati della guida, questo incorporerà tutti i file componenti che sono stati creati quando è stato creato il file della guida, sebbene alcuni formati della guida non compilati richiedano anche l'inclusione dei singoli file degli argomenti della guida nel programma.
Passaggio 9. Testare il file della guida
Una volta compilato il file della guida, devi testarlo per assicurarti che tutti i collegamenti ipertestuali si colleghino agli argomenti a cui dovrebbero e che tutta la grafica venga visualizzata correttamente. Anche il file della guida deve essere testato per garantire che il contenuto sia accurato e appropriato per gli utenti e in un formato coerente. Ti consigliamo di rivedere tu stesso il file della guida e chiedere alle persone che testano l'applicazione di esaminarlo.
Sui progetti di file di aiuto più grandi, la compilazione e il test sono processi in corso. Ti consigliamo di compilare il file di aiuto e controllare il tuo lavoro più volte prima di creare la versione finale
Passaggio 10. Fornire il file della guida allo sviluppatore da includere nel programma
A seconda della natura del progetto e del formato del file della guida, potrebbe essere necessario fornire allo sviluppatore diversi file, incluso un file mappa se sono presenti argomenti sensibili al contesto.
