[OTHER] Istruzioni Manuali

Manuale utente

I manuali non possono avere riferimenti ad altri documenti del fornitore
Il manuale deve avere un proprio glossario
Non mettere descrizioni sulle installazioni che possono essere facilmente reperite online
Per le contestualizzazioni possono essere utili degli screen
Fornire esempi di JSON (in testo semplice) in input e output alle API (che vanno descritte)
Fornire esempi di configurazione
Specificare i requisiti minimi del sistema
Non mettere requisiti hw troppo elevati
Suddividere per tipologia di utente
Non usare verbi al condizionale
Spiegare come segnalare errori e malfunzionamenti
Descrivere le funzionalità fornite dal prodotto e non la sua struttura e le sue componenti grafiche

I manuali non possono avere riferimenti ad altri documenti del fornitore
Il manuale deve avere un proprio glossario
Per le installazioni possono essere utili degli screen
Non mettere descrizioni sulle installazioni che possono essere facilmente reperite online
Fornire esempi di configurazione
Se i diagrammi sono troppo grandi ed illegibili è meglio allegare le immagini a corredo
I diagrammi UML vanno descritti
Specificare i requisiti minimi del sistema (anche quelli "lato utente")
Non mettere requisiti hw troppo elevati
Focus sui punti di estensione
Bisognerebbe descrivere come i framework adottati si integrano all'interno dell'applicazione