La Relazione Tecnica

La relazione tecnica o datasheet è un documento rivolto a tecnici specializzati, i quali leggendo il documento saranno in grado di capire, modificare e replicare il progetto descritto.

La relazione va redatta parallelamente allo sviluppo del progetto.

La relazione sarà suddivisa nelle seguenti sezioni:

TITOLO
Titolo chiaro ed esplicativo

OBIETTIVO
Definizione chiara dell'obiettivo o degli obbiettivi da raggiungere

ANALISI/PREMESSE TEORICHE
Descrivere come si è svolta l'analisi, lavoro preventivo svolto, ricerca/studio tecnologie, trascrivere gli appunti delle lezioni relativi al progetto

ANALISI DEI REQUISITI / SPECIFICHE FINALI
Individuazione di specifici parametri che il sistema deve rispettare
tutto e solo ciò che verrà realizzato, eliminare ambiguità possibili

PROGETTO E SVILUPPO
allegare diagrammi, schemi elettrici, codice adeguatamente commentato, ...
rispettare le convenzioni di scrittura del codice adottate

I diagrammi di flusso non possono descrivere l'intera applicazione web ma singole funzioni o programmi. Non è possibile descrivere con i D.F. l'interazione tra le pagine che compongono il sito, per questa descrizione si possono usare i diagrammi UML. Consegnare eventualmente più diagrammi che descrivano l'agoritmo, sia ad alto livello che a basso livello, in modo da poterlo tradurre facilmente nel codice del linguaggio scelto.

Per il VHDL:
- analisi generale dell'architettura di sistema in grado di soddisfare le specifiche e di ottimizzare le risorse a disposizione sul proprio sistema
- schemi a blocchi funzionale con descrizione delle singole funzionalità e dei segnali di interfaccia
- individuare le entity e i signal che compongono il top file.
- eventuali schemi elettrici dei singoli blocchi individuati
- scrittura della descrizione vhdl
- composizione dei vari moduli realizzati e testati

COLLAUDO
Criteri per la scelta dei test eseguiti, quali test sono stati eseguiti, risultati ottenuti

Per il VHDL:
- scrivere e simulare i test bench, che devono risultare, quanto più vicino possibile, coerenti con la verifica degli obiettivi premessi
- verifica e collaudo di ogni singola parte
- verifica del "top file"
 - collaudo finale del vhdl caricato sulle schede Fpga

IMPLEMENTAZIONE/RILASCIO
Descrivere i passaggi finali per la conclusione del progetto.

Per il VHDL:

- Conclusioni e osservazioni eventuali sulla soluzione adottata con suggerimenti su come migliorarla

MANUTENZIONE
correttivo o evolutiva

RIFERIMENTI
http://it.wikipedia.org/wiki/Ciclo_di_vita_del_software
http://it.wikipedia.org/wiki/Software_documentation
http://www.robertagerboni.it/...modello relazione

--
Prima versione del documento 20/01/15
Revisione 1 del documento 20/04/15