Consigli per stesura manuale d'uso

Buongiorno/Buonasera.

A scuola mi hanno commissionato un compito, ovvero scrivere un manuale d'uso che riguardi un software (non devo scrivere un programma davvero, devo immaginare un prodotto già finito e scriverne un manuale d'uso, appunto) o anche qualcosa che integri software/hardware. Io mi sono soffermato su quest'ultimo, pensando ad un progetto con arduino.
Le linee guida per la stesura del manuale sono queste:

  • titolo
  • indice
  • descrizione
  • requisiti
  • installazione
  • configurazione
  • consigli d'uso/avvertenze
  • risoluzione errori (troubleshooting)
  • copyright
  • contatti

avevo pensato ad un progetto sulla domotica (mi sono buttato sul classico, insomma). Però su alcuni punti non riuscivo a trovare un nesso logico, per esempio l'installazione.
Attendo una vostra risposta :slight_smile:

Beh l'installazione di un impianto domotico per me vuol dire cablare casa con linea dati, connettere fisicamente i dispositivi alla centralina.

La configurazione, per dividerla dall'installazione, la intendo più una cosa software, da fare una volta che l'impianto è pronto. Programmare la centralina, impostare luci, riscaldamento ecc ecc

Ma quindi mettiamo caso che un utente medio abbia installato (o magari aiutato da un tecnico) questo sistema, cosa dovrebbe trovare nella voce "installazione" e "configurazione"?

Magari anche nella voce "risoluzione errori"?

I passaggi da seguire per installare/configurare un sistema, come tutti i manuali del resto :slight_smile:

Stessa cosa per gli errori, cosa fare in caso di..blablabla

La cosa piu semplice è che ti scarichi un manuale di un impianto domotico commerciale e lo studi