Norme di Progetto Pagina 1 di 7 Norme di Progetto
Indice 1 - INTRODUZIONE... 3 1.1 - OBIETTIVO DEL DOCUMENTO...3 1.2 - STRUTTURA DEL DOCUMENTO...3 1.3 - RIFERIMENTI...3 1.4 - STORIA DEL DOCUMENTO...3 2 - CONVENZIONI GENERALI... 4 2.1 - DOCUMENTAZIONE DEL PROGETTO...4 2.1.1 - Forma...4 2.1.2 - Redazione e approvazione...4 2.1.3 - Comunicazione...4 2.1.4 - Archiviazione...5 2.1.5 - Protezione...5 2.2 - COMUNICAZIONE...5 2.3 - ORGANIZZAZIONE DELLO SPAZIO DI LAVORO...5 2.4 - STRUMENTI UTILIZZATI...5 2.4.1 - Strumenti per la documentazione...6 2.4.2 - Strumenti per l ingegnerizzazione...6 2.4.3 - Strumenti per la programmazione...6 3 - CONVENZIONI DI SVILUPPO... 7 3.1 - NORME DI ANALISI...7 3.2 - NORME DI PROGETTAZIONE...7 3.3 - NORME DI CODIFICA...7 Pagina 2 di 7 Norme di Progetto
1 - Introduzione 1.1 - Obiettivo del documento Contiene le norme per la conduzione delle attività di progetto, quali le regole per la documentazione, per la comunicazione, per l organizzazione dello spazio di lavoro e per gli strumenti di lavoro. Inoltre le norme di analisi, progettazione e sviluppo specifiche per il progetto in questione. 1.2 - Struttura del documento Il presente documento è così strutturato: 1. Introduzione: definisce gli obiettivi e riporta i riferimenti e la storia del documento. 2. Convenzioni generali: definisce convenzioni di carattere generale per il corretto svolgimento, secondo le norme di qualità, del lavoro all interno dell azienda. 3. Convenzioni di sviluppo: contiene le norme di sviluppo specifiche relative al progetto. 1.3 - Riferimenti Manuale della qualità 1.4 - Storia del documento Versione attuale: 1.1 Redazione del documento Autore Data Versione Firma Rosalia Giulio Giuseppe 10/11/2005 1.0 Rosalia Giulio Giuseppe * 18/01/2006 1.1 Approvazione del documento Autore Data Versione Firma Ortisi Paolo 19/11/2005 1.0 Ortisi Paolo 19/01/2006 1.1 * Modificati i paragrafi 2.4.2 e 3.3 Pagina 3 di 7 Norme di Progetto
2 - Convenzioni generali 2.1 - Documentazione del progetto Tutta la documentazione inerente la società e il progetto sarà mantenuta e modificata secondo le regole stabilite in questo paragrafo. 2.1.1 - Forma Tutta la documentazione prodotta dalla cin>>c8 avrà la seguente forma: Intestazione contenente il logo della società in alto a sinistra e nome completo della società in calce al logo; Piè di pagina contenente il numero della pagina in questione, il numero totale di pagine del documento e il nome del documento. Fatta esclusione per i verbali dell assemblea, che non dovranno necessariamente seguire lo standard di riferimento elencato qui di seguito, tutti i documenti della cin>>c8 dovranno contenere inoltre: Prima pagina di copertina, contenente al centro pagina il nome del documento; Indice del documento; Introduzione al documento, nella quale illustrare l obiettivo, la struttura, i riferimenti e la storia del documento. Il documento verrà strutturato in capitoli ed eventuali paragrafi e sottoparagrafi, fino ad un massimo di tre livelli. La numerazione per i capitoli sarà la numerazione araba, e i paragrafi e sottoparagrafi dovranno necessariamente seguire la numerazione del capitolo o paragrafo di appartenenza. L indice del documento riporterà i riferimenti ai capitoli, ai paragrafi e ai sottoparagrafi del documento. Il modello di riferimento, per quanto riguarda carattere, dimensioni, spaziatura e margini è stato creato con Microsoft Word 2003 ed è entrato a far parte dei prodotti del progetto con il nome Modello.dot in data 09/11/2005. Il modello è inoltre reperibile presso l archivio di progetto sul web (cfr. 2.3). 2.1.2 - Redazione e approvazione Il redattore di un documento dovrà registrare, con il suo nome e la sua firma negli appositi spazi definiti all interno dell introduzione del documento, la creazione del documento. Successivamente alla redazione, il documento verrà approvato da uno o più elementi dell azienda, e solo dopo l approvazione il documento potrà essere registrato nel diario di progetto. Ogni eventuale modifica ad un documento già approvato e archiviato nel diario di progetto, dovrà essere registrata, con l aggiornamento della versione del documento, con la firma della nuova redazione, ed esso dovrà necessariamente essere approvato nuovamente da uno o più membri dell azienda. 2.1.3 - Comunicazione Ogni inserimento di documentazione all interno del diario di progetto verrà comunicato, tramite comunicazione per posta elettronica, al Manager dell azienda, che, ricevuto il documento, si occuperà di trasmettere agli eventuali membri interessati, tramite posta elettronica, la comunicazione dell avvenuta redazione o modifica di un documento, rimandando gli stessi all archivio disponibile sul web per l eventuale visione o download del documento. Pagina 4 di 7 Norme di Progetto
2.1.4 - Archiviazione Ogni documento aziendale dovrà essere mantenuto in un minimo di due copie identiche: Una copia dovrà essere mantenuta dal Manager; Una copia dovrà essere mantenuta nell archivio di progetto sul web. Sarà cura del Manager caricare sull archivio di progetto sul web ogni nuova versione di un documento, comunicando al personale il cambiamento (cfr. 2.1.3). L archivio di progetto sul web sarà disponibile all URL specificato nel capitolo 2.3 Organizzazione dello spazio di lavoro. 2.1.5 - Protezione Per facilitare la protezione di ogni documento dell azienda, e per evitare eventuali approvazioni improprie di documenti o parti di essi prodotti dalla cin>>c8, ogni documento prodotto e pubblicato sull archivio di progetto sul web, verrà registrato in formato PDF protetto, consentendo solo visione e stampa dello stesso. La responsabilità per la protezione dei documenti spetta al Manager, che si occuperà di trasformare ogni documento pervenutogli, in PDF protetto, applicando una password di protezione a conoscenza del solo Manager stesso. 2.2 - Comunicazione La comunicazione all interno dell azienda sarà effettuata tramite posta elettronica. Ogni comunicazione di carattere generale verrà effettuata dal Manager verso tutti i componenti aziendali sotto forma di e-mail a più destinatari, ed eventuali informazioni di carattere più ampio verranno pubblicate all URL dell archivio di progetto sul web (cfr. 2.3). Tutte le comunicazioni personali potranno avvenire in qualsiasi forma, e nessun tipo di comunicazione interna dovrà essere registrata nel diario di progetto, salvo necessità formale o esplicita richiesta. 2.3 - Organizzazione dello spazio di lavoro Lo spazio di lavoro comune a tutti i membri dell azienda sarà composto da un archivio di progetto sul web. L archivio sarà pubblicamente disponibile, e si comporrà di una pagina web indice nella quale saranno contenuti: Documenti aziendali in formato PDF protetto da password (cfr. 2.1.5) Prodotti aziendali di uso comune Progetto software o parti di esso Collegamenti a riferimenti esterni Eventuali comunicazioni di carattere generale Le modifiche all archivio di progetto sul web saranno di responsabilità del Manager, e ogni aggiornamento all archivio sarà comunicato a tutti i membri dell azienda. L archivio sarà disponibile al seguente URL: http://user.shockside.org/~cinc8 2.4 - Strumenti utilizzati Gli strumenti utilizzati all interno della cin>>c8 sono suddividibili in base al loro campo di utilizzo, e si raggruppano nelle seguenti categorie: Strumenti per la documentazione; Strumenti per l ingegnerizzazione; Strumenti per la programmazione; Pagina 5 di 7 Norme di Progetto
2.4.1 - Strumenti per la documentazione Per la produzione della documentazione verranno utilizzati i seguenti software: Suite Microsoft Office 2003, per la realizzazione della documentazione; Macromedia Fireworks MX, per la realizzazione e la modifica delle immagini; Adobe Acrobat Professional 6, per la pubblicazione e protezione dei documenti. 2.4.2 - Strumenti per l ingegnerizzazione Per l ingegnerizzazione e le fasi di analisi verranno utilizzati i seguenti software: Sparx Systems Enterprise Architect 5.0 PlanBee 1.4 Microsoft Project Professional 2003 2.4.3 - Strumenti per la programmazione Per la programmazione del progetto, si riserva la facoltà al singolo programmatore di scegliere gli strumenti più adatti, secondo le esigenze del singolo, di modo tale da non costringere un programmatore a lavorare in un ambiente di lavoro non familiare. Ogni programmatore dovrà comunque attenersi alle norme di codifica relative al linguaggio di programmazione utilizzato (cfr. 3.3). Pagina 6 di 7 Norme di Progetto
3 - Convenzioni di sviluppo 3.1 - Norme di analisi Durante lo sviluppo del progetto, e più in specifico durante la fase di analisi del dominio e di analisi dei requisiti del sistema, per la stesura della documentazione verranno seguite tutte le regole già definite in questo stesso documento nel paragrafo riguardante la progettazione (cfr. 2.1). Inoltre, poiché potrebbe ritenersi necessario l utilizzo di linguaggio UML (Unified Modelling Language) per la semplificazione della visione dei casi d uso del sistema, in questo caso il linguaggio UML sarà quello standard, aggiornato alla versione 2.0. Le specifiche di questo linguaggio sono state archiviate come documentazione esterna in data 10/11/2005, con il nome UML (Unified Modelling Language) 2.0, e sono reperibili presso l archivio di progetto sul web e presso il seguente URL: http://www.omg.org/cgi-bin/doc?ptc/03-08-02 3.2 - Norme di progettazione Per la fase di progettazione, che include la redazione della specifica architetturale e della specifica di dettaglio di un progetto, per la stesura della documentazione verranno seguite tutte le regole già definite in questo stesso documento nel paragrafo riguardante la progettazione (cfr. 2.1). Inoltre, poiché sarà necessario un continuo utilizzo di linguaggio UML (Unified Modelling Language) per la stesura delle specifiche, verrà utilizzato il linguaggio UML standard alla versione 2.0, le cui specifiche sono state archiviate come documentazione esterna in data 11/11/2005, con il nome UML (Unified Modelling Language) 2.0, e sono reperibili presso l archivio di progetto sul web e presso il seguente URL: http://www.omg.org/cgi-bin/doc?ptc/03-08-02 3.3 - Norme di codifica Per la codifica del progetto software, si tende a mantenere una forma di codifica uguale per tutti i programmatori. Per fare ciò, si delineano alcune linee guida per la programmazione nei due linguaggi di riferimento, C e Java. Per entrambi i linguaggi, quindi, verranno utilizzate alcune regole di stile nella programmazione. Le regole selezionate sono le regole di stile della Geotechnical Software Services per quanto riguarda la programmazione Java e le regole redatte dalla Zoology Computer Systems University of Toronto. Si è fatta questa scelta poiché sono le regole più comuni e più importanti per i due linguaggi di programmazione. Le linee guida per il linguaggio di programmazione C sono archiviate come documentazione esterna in data 18/01/2006, con il nome Indian Hill C Style and Coding Standards, e sono reperibili presso l archivio di progetto sul web e inoltre presso il seguente URL: http://www.chris-lott.org/resources/cstyle/indhill-annot.html Le linee guida per il linguaggio di programmazione Java sono archiviate come documentazione esterna in data 10/11/2005, con il nome Linee Guida Programmazione Java, e sono reperibili presso l archivio di progetto sul web e inoltre presso il seguente URL: http://geosoft.no/development/javastyle.html Sono inoltre presenti le linee guida del linguaggio di programmazione C++, anch esse della Geotechnical Software Services, per un eventuale consultazione. Sono archiviate come documentazione esterna in data 10/11/2005, con il nome Linee Guida Programmazione C++, e sono reperibili presso l archivio di progetto sul web e inoltre presso il seguente URL: http://geosoft.no/development/cppstyle.html Pagina 7 di 7 Norme di Progetto