Buone referenze per esempi di documentazione per l'utente finale e consigli [chiuso]

10

Il nostro software interno è stato utilizzato da molti utenti e il dipartimento di formazione ci ha chiesto consigli sul formato della documentazione per l'utente finale.

Qualcuno sa dove posso trovare buoni esempi di documentazione per l'utente finale del software che un dipartimento di formazione può utilizzare per l'ispirazione o siti con buoni consigli?

Questo è simile a questa domanda, tuttavia sto cercando la documentazione per l'utente finale per l'uso utilizzato da utenti non tecnici.

design documentation users

— John
fonte

1

"dove posso trovare buoni esempi di documentazione per l'utente finale del software" Passaggio 1. Acquista del software. Passaggio 2. Leggere la documentazione. Cosa ti impedisce di raccogliere la documentazione dal software esistente che stai già utilizzando? Ritengo che la maggior parte dei pacchetti per utenti finali disponga della documentazione completa online. Cosa ti impedisce di leggere la documentazione di Microsoft per la loro Office Suite?

— S.Lott

Credo che la maggior parte della documentazione che ho letto sia scritta in un modo che non è attraente da leggere, e la maggior parte dei libri che ho sono generalmente legati alla programmazione rivolti al pubblico tecnico. Vedi l'ultima volta che qualcuno ha letto il manuale di Microsoft? Quindi stavo cercando alcuni esempi di ispirazione.

— Giovanni,

Hmm, interessante q.

— Torre del

@John: "la maggior parte della documentazione". Va bene. Quindi, dopo aver scartato "la maggior parte", cosa rimane? Non sappiamo perché stai rifiutando alcuni dei documenti più utilizzati sul pianeta come "non attraenti da leggere". Potresti ampliare il tuo elenco di reclami e aggiungere il tuo breve elenco personale di esempi di documentazione software che non è escluso dal test "non attraente per la lettura". Non ti conosciamo molto bene, quindi non possiamo indovinare il motivo per cui non intendi leggere.

— S.Lott

2

Facciamo attenzione a non richiedere domande con criteri così specifici di ciò che è "buono" da diventare localizzato e non applicabile alla maggior parte delle persone. Non mi interessano le combinazioni di colori.

— JeffO,

1

Potresti iniziare intervistando i tuoi utenti interni sul software e scoprire che tipo di informazioni vorrebbero sapere.

Gran parte della documentazione che ho scritto sul software ha avuto in mente uno o più destinatari. Il tuo dipartimento di formazione probabilmente trarrebbe beneficio da uno scheletro di argomenti (come un sommario). Quindi potresti discutere quali argomenti sono rilevanti e quali sono irrilevanti rispetto ai loro obiettivi di formazione.

Alcuni degli argomenti potrebbero riguardare:

Fascia degli ascoltatori)
Requisiti tecnici
Come installare (se applicabile)
Processo (ovvero quale funzione aziendale svolge il software?)
Featureset (quali funzionalità ha il software?)
- Potresti avere un approccio basato su attività a questo, ad esempio Aggiungi un utente o Aggiungi un documento
- Potresti avere un approccio basato sugli oggetti, ad esempio Utenti, Ruoli
- Si potrebbe avere un approccio basato su menu, ad es. Menu File, Visualizza menu
Infine, probabilmente una sezione delle prossime funzionalità e domande frequenti potrebbe fungere da archivio di conoscenza crescente del tuo prodotto.

Prova ad anticipare come gli utenti finali utilizzano il tuo software, in base alla tua conoscenza dello sviluppo, alla tua conoscenza di ciò che fa e anche sulla base (si spera) delle tue interviste con gli utenti finali.

Ancora più importante, prova a fare la documentazione che vorresti leggere, usa esempi divertenti per dimostrare e usa molti screenshot annotati.

Spero che sia di aiuto

— funkymushroom
fonte

2

Ho letto diverse "Guide per l'utente finale" e ne ho scritto una e penso che ci siano molti elementi che ne migliorano l'efficacia:

Mostra con le immagini come viene emesso un comando o eseguito un'azione (ad esempio schermate).
Concentrati sulla necessità di fare qualcosa e sul modo di farlo. Stai lontano dalle descrizioni tecniche su come viene ottimizzata quell'azione, ad esempio.
Una volta messo un diagramma di flusso che descrive i moduli, il software è stato diviso e ho ricevuto commenti che non erano molto utili.
Prova a prevedere i possibili problemi che un utente potrebbe avere, in modo che la sezione Risoluzione dei problemi sia utile. Devi anche testare il tuo programma con utenti che non sono stati coinvolti nel suo sviluppo, anche con i tuoi colleghi che hanno attirato su altri progetti.
Evita descrizioni noiose. Ogni ulteriore informazione può essere inserita in un'appendice o qualcosa del genere.

Spero che questo possa esserti utile.

— Nicolás
fonte

1

Dici che sarà usato per l'allenamento.

Se stai cercando un documento di formazione piuttosto che un documento di riferimento, il mio sito preferito è il tutorial di Joel Spolsky su Mercurial qui .

Presentazione semplice e pulita. È bello da vedere.
Autorevole, ma di tono personale. Sembra di essere in una grande conferenza universitaria.
Immagini semplici, non quantità copiosa di schermate effettive. Leggi The Back of the Napkin per il motivo per cui funziona.

Se il tuo documento di allenamento fosse interessante come il tutorial di Mercurial di Joel, lo leggerei. Ma hai bisogno di qualcuno con a) la passione per la scrittura eb) un'incredibile profondità di conoscenza per riuscirci, anche se potresti copiare i 3 punti sopra. Spero funzioni.

— MikeRand
fonte

0

Non so se questo potrebbe adattarsi alle tue esigenze, ma ci sono sistemi là fuori usati per la sfinge della documentazione tecnica che viene in mente che facilitano la creazione di una documentazione online. Potrebbe essere usato qualcosa del genere per quello che ti interessa?

Ho anche incontrato ReadTheDocs che fa la stessa cosa ma è una soluzione ospitata.

— Piper Merriam
fonte

0

Dai un'occhiata alla Society for Technical Communication (STC) . Molti dei loro vincitori hanno scritto produzioni generalmente disponibili. Possono anche avere campioni disponibili. Diventare membro fornirà anche l'accesso a un corpus di informazioni più ampio.

— Jim Rush
fonte