Vai al contenuto

Introduzione -->

Scopo del documento

Lo scopo del Manuale UtenteG è quello di introdurre il lettore al Sistema sviluppato da ALimitedGroup per il Capitolato C6: Sistema di Gestione di un Magazzino Distribuito.

A tale scopo il manuale illustrerà i requisiti minimi necessari ad avviare il Sistema, a partire dai programmi necessari alla sua esecuzione, per poi proseguire a descrivere come configurare il Sistema in base alle proprie esigenze, e come avviare lo stesso.

Successivamente, vengono descritte le operazioni necessarie per la corretta operazione e manutenzioneG del Sistema, in particolare su periodi di tempo prolungati.

La parte finale di questo manuale ha l'obiettivo di esporre tutte le conoscenze necessarie per un utilizzo efficace del Sistema. Ciò è fatto seguendo i principi di Diátaxis, un "Approccio sistematico alla produzione di documentazione tecnica". In particolare, sono presenti le seguenti sezioni:

  • Concetti: una spiegazione completa dei concetti chiave che potrebbe essere necessario conoscere per usare il Sistema. Essa segue la forma di documentazione Explanation, come indicato dal Diátaxis;

  • TestG: una breve introduzione all'esecuzione dei testG di unità, integrazione e accettazione;

  • Installazione: una spiegazione completa su come scaricare, installare, configurare ed avviare il Sistema;

  • Guide: delle guide rapide con l'obiettivo di guidare l'utente mentre effettua una particolare azione. Essa segue la forma di documentazione How-to guides, come indicato dal Diátaxis;

  • Telemetria: una guida alla configurazione di GrafanaG e al suo utilizzo.

  • Riferimento API: specifica con il massimo dettaglio ogni aspetto delle chiamate APIG possibili; utile per l'utente che necessita di una specifica dettagliata del funzionamento dell'API. Essa segue la forma di documentazione Reference, come indicato dal Diátaxis.

Glossario

La realizzazione di un Sistema software richiede, ancor prima della scrittura del codice, un’importante operazione di confronto, analisi e progettazione: per supportare e facilitare il lavoro asincrono tutte le informazioni derivate da questa attività saranno appositamente documentate.

È completamente ragionevole tuttavia pensare che tali documenti potrebbero contenere parole e terminologie complesse o comunque non direttamente comprensibili: è stato deciso dunque di realizzare un Glossario, nella quale saranno contenuti le spiegazioni relative a tali termini. Tale documento è in costante aggiornamento ed è reperibile, nella sua versione attuale, all'indirizzo https://alimitedgroup.github.io/glossario.html. È disponibile anche una versione in formato pdf.

Le parole che possiedono un riferimento nel Glossario saranno indicate nel modo seguente:

parolaG

Riferimenti

Riferimenti normativi

Riferimenti informativi