Sto cercando modelli (comuni / astratti) ed esempi per la documentazione del software (utente finale). Mi serve in particolare qualcosa per una "Guida all'installazione", una "Guida operativa" (funzionamento / assistenza / amministrazione del software), "Guida per l'utente" e "documenti di formazione". Ho cercato su google, non ho trovato risorse utilizzabili. Sto anche cercando linee guida per la progettazione.
È una grande sorpresa per me, ma Microsoft ha finalmente iniziato a rendere disponibili documenti validi, utili e leggibili. Vivono in MSDN e potrebbero darti un'idea di come sono organizzati i buoni documenti. Ad esempio, la sezione su DLL è buono, credo.
E quindi puoi iniziare qui al livello più alto .
Il meglio che ho trovato sono tutorial / storie piuttosto che enciclopedie per i documenti delle applicazioni per l'utente finale - al contrario dei documenti della biblioteca.
Scegli alcune delle procedure più comuni e commentale passo passo.
Questo è molto più utile dei documenti che rispecchiano semplicemente la guida in linea, che è piena di voci taglia-incolla come "questo è il pulsante blah, attiva la funzione blah"
Sono d'accordo con @SnOrfus: cerca un buon esempio e copia il modello.
Sai già che quasi tutta la documentazione per l'utente finale fa schifo; è così, così brutto: prolisso, un sacco di parole estranee, piene di parole furbe - "si raccomanda che", "l'utente è spinto a", tutte le cagate del genere. Solo il 90% di puro hooey. E, a proposito, ricorda che tutte queste cosiddette "guide utente" sono lunghe circa 1200 pagine e costano $ 89,95.
Ci sono sicuramente alcuni buoni esempi in giro, però. Kernighan e Ritchie, Linguaggio di programmazione C è il miglior esempio di un buon documento per l'utente finale che io conosca. È breve; usa parole normali e quotidiane; è completo; è corretto. Una bellissima opera d'arte, a mio parere, che si adatta comodamente in 256 pagine (prima edizione).
Un buon forum per questa domanda è il gruppo di scrittori su StackExchange . A volte troverai discussioni sui documenti tecnici degli utenti finali.
Leggi altre domande sui tag documentation users