Esistono standard per la preparazione di un manuale utente del dispositivo elettronico? [chiuso]

Il manuale dovrebbe contenere tutto ciò che il proprietario del dispositivo deve sapere, incluso ma non limitato a:

• Disimballaggio: come decomprimerlo
• Operazione: come utilizzarlo
• Integrazione: come usarlo in combinazione con altri dispositivi, se opportuno
• Cura: come prendersene cura
• Materiali di consumo: dove trovare i materiali di consumo che il dispositivo richiede
• Risoluzione dei problemi: cosa fare quando non sembra funzionare
• Servizio: chi contattare se ha bisogno di riparazioni
• Sicurezza: tutte le informazioni sulla sicurezza necessarie
• Riciclaggio e smaltimento: come eliminarlo responsabilmente
• Garanzia: dichiarazione di garanzia ed eventuali rinunce o altre note legali
• Indice: un indice completo

Se l'utilizzo del dispositivo è complicato e / o se non ci si aspetta che gli utenti siano già ben informati, potrebbe essere una buona idea includere alcuni esempi.

Non sono a conoscenza di standard generali di scrittura manuale, ma sono sicuro che alcuni esistono per mercati specifici. Ad esempio, si può facilmente immaginare che si dovrebbe fornire un manuale che soddisfi determinati criteri se si prevede di vendere all'esercito, e alcuni paesi potrebbero richiedere che il manuale sia fornito nella lingua ufficiale di quel paese.

Per le idee, dai un'occhiata ai manuali forniti con l'auto, il frullatore, lo stereo, il DVR, la stampante, il forno a microonde e tutti gli altri dispositivi che hai in casa.

Ecco cosa consiglierei:

• Prendi la scatola del tuo iPhone o iPod e il manuale,
• Replica le sezioni in base al dispositivo e al contenuto.

^{(Scegliere un dispositivo più vicino al tuo tipo di dispositivo potrebbe essere più adatto, ho appena fatto un esempio con un probabile supporto decente per queste cose.)}

Esistono alcuni standard diversi:

• MIL-STD-498
• IEEE 12207-2008
• Standard di documentazione per la fase di implementazione (standard del governo di Hong Kong)

Formato generale:

1. Prima pagina con tutte le informazioni sulla versione necessarie e dettagli del autore & pagina / e del contenuto dell'editore
2. Affari generali sulla vista dell'ambito e dello scopo del sistema
3. Informazioni generali sulla portata e lo scopo del manuale
4. Vista generale del software, comprese le funzionalità e i requisiti hardware e software
5. Utente generale orientato sulla vista del software
6. Guida introduttiva, copertine: installazione, configurazione, utilizzo per la prima volta, qualsiasi password predefinita ect
7. Elaborazione di riferimento, guida l'utente nell'esecuzione di ogni operazione che il sistema è in grado di

Per maggiori dettagli vedi MIL-STD-498