Software Requirements Specification

Transcript

1 SJS Sicilian Java Solutions Software Requirements Specification Data di inizio redazione: 16/11/2008 Data di fine redazione: 19/11/2008 Versione: 1.0 Redattore: Pennisi Carmelo Approvatori: Di Giorgio Veronica, Marianna Nicolosi 1. Introduzione 1.1.Obiettivo del Documento Questo documento è stato redatto per gli sviluppatori, in modo da permettere il corretto e rapido sviluppo del software BRAINING the brain training, e contiene una descrizione dettagliata dei requisiti che devono essere soddisfatti. Il documento conterrà la definizione e la descrizione dei requisiti di interfaccia, funzionali, e di performance. 1.2.Prospettive del Progetto Il progetto si prefigge lo scopo di realizzare un Video Game Educativo, che permetterà agli utenti di allenare la propria mente, tramite una serie di giochi divertenti. Il software proporrà agli utenti che posseggono un computer, una buona alternativa a progetti simili attualmente disponibili solo per dispositivi console. Il software sarà realizzato, inoltre, in modo da poter essere eseguito su hardware datato. Le conoscenze informatiche richieste per l'utilizzo del software saranno minime, grazie all'utilizzo di interfacce User Friendly. 1.3.Definizioni, Acronimi e Abbreviazioni Le definizioni, gli acronimi e le abbreviazioni usate all'interno di questo documento sono consultabili nella Tabella delle Definizioni allegata. 1.4.Descrizione del Documento I prossimi punti del documento conterranno i dettagli sui requisiti e le funzionalità che il software deve avere. Saranno forniti dettagli agli sviluppatori su come il software deve essere Pagina 1 9

2 strutturato, e requisiti di interfaccia che coadiuveranno gli sviluppatori al fine di produrre GUI essenziali e di semplice utilizzo. Una descrizione dettagliata dei requisiti sarà data al punto 3 di questo documento. 2. Descrizione Generale 2.1.Caratteristiche degli Utenti Il target utenti a cui il software è rivolto è composto da quelle persone che vogliono mantenere la propria mente allenata e giovane, che posseggono un PC e che amano divertirsi mentre imparano. Non saranno necessarie particolari conoscenze del computer, ne hardware potenti e costosi. L'utente che vorrà cimentarsi nella risoluzione dei giochi/trainer, dovrà avere capacità matematiche, lessicali e logiche elementari. L'interfaccia utente del software dovrà essere essenziale, e di facile utilizzo. Le funzioni dovranno essere bene in mostra e a portata di clic. Ogni funzione azionabile dall'utente sarà gestita mediante bottoni. Saranno presenti TextBox all'interno delle varie interfacce per fornire agli utenti un sistema per inserire dati. Ogni informazione che deve essere mostrata all'utente sarà mostrata tramite Label. Le etichette dei vari bottoni, dovranno essere esplicative della funzione. L'età minima richiesta agli utenti, per l'utilizzo del software è fissata nominalmente a 15 anni. 2.2.Prospettiva del Prodotto Il software sarà in formato stand alone e non prevede interazione con altri software. Il programma dovrà interfacciarsi con un database, sviluppato in MYSQL 5. Saranno gestite interrogazioni al database, per la gestione degli account utente e dei dati di gioco. L'iterazione tra il software e il database sarà completamente invisibile per l'utente, e automatica. Questa' interfaccia sarà integrata all'interno del codice Java. Il software girerà sulle maggiori piattaforme sul mercato, grazie all'utilizzo della Java Virtual Machine che provvederà a gestire automaticamente ed indipendentemente dal S.O, l'hardware della macchina, evitando al software la diretta interazione con l'hardware stesso. 2.3.Descrizione Generale dei Requisiti Funzionali Il software proporrà quattro categorie di trainer che serviranno ad allenare le capacità di memoria, logiche, lessicali e matematiche dell'utente. Ogni trainer consiste in un gioco, con difficoltà crescente, che sarà proposto all'utente in modo automatico. Ogni gioco sarà temporizzato. Superato il limite di tempo il gioco sarà concluso e giudicato insoluto. I risultati saranno registrati automaticamente all'interno di un database. L'utente avrà la facoltà di chiudere il programma, e/o uscire dal proprio account, in qualunque momento. Ogni utente potrà gestire il proprio account, modificando i dati, cancellando i progressi, o eliminando l'account stesso dal programma. Sarà possibile, inoltre, eseguire nuovamente i giochi già risolti a scopo di divertimento che non concorrerà ai fini delle statistiche e del calcolo dell'indice di età cerebrale. Il software genererà in modo automatico l' indice di età cerebrale, e in più fornirà grafici e reports che mostreranno la crescita intellettuale dell'utente. Alle spalle del software verrà posto un database in cui saranno memorizzati tutti i dati degli account, e tutti i risultati ottenuti nei vari trainer. Il software permetterà infine l'aggiornamento dei giochi disponibili tramite internet. Pagina 2 9

3 2.4.Vincoli Generali Il software potrà essere eseguito solo su computer equipaggiati con tecnologia Java. Sarà dunque necessario installare sulla propria macchina, prelevandola gratuitamente dal sito della SUN ( ) la Java Virtual Machine, componente essenziale per l'avvio e l'esecuzione di tutto il programma. Questa componente fa parte del pacchetto Java Runtime Environment, JRE, prelevabile dal sito della SUN. I computer su cui il software può girare devono soddisfare i seguenti requisiti minimi: Processore Intel o AMD, con frequenza di 1000 Mhz o superiore. 128 MB, o più, di memoria RAM. Scheda grafica con almeno 32 MB di memoria dedicata. Almeno X MB di spazio libero su disco. ( con X da definire a posteriori della definizione dei punti funzione.) 3. Specifica dei Requisiti 3.1.Requisiti di Interfaccia Il software deve soddisfare i seguenti requisiti di interfaccia: Utilizzo di componenti grafiche fornite dalle librerie grafiche di Java. Presenza di Label per la visualizzazione di messaggi e informazioni. Utilizzo di TextBox come sistema per l'inserimento da tastiera dei dati. Utilizzo di Bottoni per avviare le funzioni, aprire e chiudere le interfacce, operare sui dati. L'interfaccia di Avvio del software deve rimanere aperta fino alla chiusura del software. La chiusura dell'interfaccia di Avvio provvederà anche alla terminazione del software. Le altre interfacce dovranno essere visualizzate su un frame diverso da quello usato per l'interfaccia di Avvio. Ogni interfaccia, ad eccezione di quella di avvio, deve essere visualizzata all'interno dello stesso Frame dell'interfaccia precedente che l'ha richiamata. Ogni interfaccia conterrà un Bottone che permetterà la chiusura e che mostrerà l'interfaccia precedente da cui è stata richiamata. Il modulo per la registrazione dell'account conterrà delle TextBox per inserire i dati, che saranno descritti da Label poste in corrispondenza di ogni TextBox. Sarà presente inoltre un bottone per Committare i dati. Il modulo di login conterrà delle TextBox per i dati, e le relative Label più il bottone per accedere. L'interfaccia dei giochi, conterrà oltre a quanto previsto in generale per tutte le interfacce, un Canvas sul quale sarà mostrato il gioco. Sarà presente un interfaccia contenente, oltre a quanto previsto in generale per tutte le interfacce, anche un Canvas sul quale verrà mostrato un grafico, generato tramite componenti grafiche di Java. Per la modifica dei dati, le varie interfacce verranno aperte, eccezionalmente, in un frame diverso da quello dell'interfaccia dalla quale sono state richiamate. Le interfacce per la modifica dei dati conterranno, diversamente da quanto disposto per tutte le altre interfacce, delle Label che mostrano il dato da modificare, TextBox per inserire il dato modificato. Le interfacce di modifica conterranno, inoltre, bottoni di Commit, che provvederanno alla registrazione della modifica sul Database e chiuderanno l'interfaccia, e di annullamento Pagina 3 9

4 dell'operazione, che chiuderanno l'interfaccia senza apportare alcuna modifica. Al passaggio del mouse su bottoni e TextBox verranno mostrate le descrizioni relative, al fine di guidare l'utente. 3.2.Descrizione Dettagliata dei Requisiti Funzionali Il software realizzato deve soddisfare i seguenti requisiti: Interfaccia per la creazione dell'account utente ID R1 All'interno dell'interfaccia di avvio del software, deve essere presente un bottone con etichetta Crea Utente, il quale una volta premuto avvierà un'interfaccia in cui sarà presente un modulo di registrazione. I campi del modulo, in forma di TextBox, devono essere tre e devono avere associate le seguenti Label: Nome Età Password All'interno dell'interfaccia sarà presente in basso un bottone con etichetta Crea, che non deve essere cliccabile a meno che non siano state correttamente riempite le tre TextBox. Una volta cliccato su Crea i dati devono essere controllati e memorizzati nel database mediante una Query di inserimento nella tabella Account. Questo salvataggio dovrà essere mascherato all'utente, a cui sarà, automaticamente, mostrata l'interfaccia di avvio. Modulo di inserimento dati di accesso all'account. ID R2 All'interno dell'interfaccia di avvio del programma, deve essere presente un modulo per l'inserimento dei dati di accesso all'account utente. Il modulo deve essere composto da due TextBox. Le Label devono essere: Nome Utente Password Deve essere presente inoltre un bottone con etichetta Accedi, al cui clic verrà fatta, in modo invisibile per l'utente, una query al database, sulla tabella Account. La query controllerà che nel database sia presente il Nome Utente inserito, e che la password ad esso associata corrisponda con quella digitata nel modulo di accesso. Se il controllo va a buon fine, il programma deve mostrare all'utente l'interfaccia di Gioco. Altrimenti il software deve cancellare il contenuto delle TextBox Nome Utente e Password e mostrare una nuova Label con scritto Nome Utente e Password non corretti, sotto il bottone Accedi. Pannello di Gestione degli account utente. ID R3 All'interno dell'interfaccia di Gioco deve essere presente un bottone con etichetta Pannello Utente, al cui clic deve essere mostrata all'utente un'interfaccia di Gestione Account. In questa interfaccia devono essere presenti tutti i dati dell'utente in forma di Label. Devono essere mostrati i seguenti dati: Nome Utente Età Livello Età cerebrale Numero di giochi svolti Punteggio Pagina 4 9

5 Modifica dei dati utente. ID R4 All'interno dell'interfaccia di Gestione Account, le Label Nome Utente e Età devono essere accostate da un pulsante con etichetta Modifica. Se l'utente clicca sul pulsante Modifica, deve essere mostrata all'utente un interfaccia in cui sono presenti una TextBox, al cui interno l'utente può digitare il valore corretto ed un pulsante con etichetta Fatto al cui clic deve essere effettuata una query al database che aggiornerà il campo selezionato con il valore inserito dall'utente. Alla fine della query, invisibile per l'utente, a quest'ultimo sarà mostrata nuovamente l'interfaccia di Gestione Account. Deve essere inoltre disponibile un bottone con etichetta Cambia Password, al cui clic deve essere aperta un'interfaccia contenente una Label con la vecchia password, due TextBox, in cui andrà digitata due volte, per sicurezza, la nuova password. Cancellazione account ID R5 All'interno dell'interfaccia di Gestione Account deve essere presente un bottone con etichetta Cancella Account, al cui clic sarà cancellato l'utente dal database mediante una query di cancellazione sulla tabella Account, eliminando tutti i campi del record corrispondente all'utente. Chiusura Account ID R6 All'interno dell'interfaccia Gioco deve essere presente un bottone con etichetta Esci, al cui clic il software deve tornare all'interfaccia di Avvio. Reset account. ID R7 All'interno dell'interfaccia di Gestione Account deve essere disponibile un bottone con etichetta Reset Account, che permetterà, una volta cliccato, di resettare tutti i progressi dell'utente, mediante una query di aggiornamento sulle tabelle Risultati, cancellando tutti i record relativi all'utente in questione, e Account, impostando a 1 il campo Livello. Selezione modalità di gioco. ID R8 All'interno dell'interfaccia di Gioco devono essere presenti due bottoni con etichette, Allenamento e Tempo Libero, che permetteranno all'utente, mediante clic su uno di essi, di avviare la corrispondente modalità di gioco. Modalità Allenamento. ID R9 Se viene avviata la modalità Allenamento, deve essere mostrata all'utente un'interfaccia che contenga due Label, ed un pulsante con etichetta Avvia. Le due Label devono contenere, il livello dell'utente e il nome del Trainer che sarà avviato. Al clic sul pulsante Avvia all'utente verrà mostrata un'interfaccia contenente il gioco precedentemente mostrato. All'interno di quest'interfaccia, valido per ogni gioco avviato, sarà presente oltre al gioco stesso, un bottone, con etichetta Termina Trainer, che permetterà in qualunque momento di terminare l'esecuzione del trainer e tornare all'interfaccia di Gioco. Modalità Tempo Libero. ID R10 Pagina 5 9

6 Se viene avviata la modalità Tempo Libero, deve essere mostrata un'interfaccia che contenga un elenco dei giochi già svolti dall'utente, e ad ogni gioco deve essere associato un bottone con etichetta Avvia, al cui clic sarà avviato il gioco corrispondente, per essere eseguito nuovamente dall'utente. Chiusura interfaccia. ID R11 Ogni interfaccia del software, ad eccezione di quella di Avvio e di Gestione Account, dovrà contenere, oltre a quanto già definito specificatamente, anche un bottone, con etichetta Indietro, che permette all'utente di chiudere l'interfaccia corrente tornando all'interfaccia di livello superiore. Salvataggio automatico dei risultati. ID R12 Alla conclusione, senza interruzione da parte dell'utente, di ogni trainer, il risultato ottenuto deve essere memorizzato, temporaneamente, all'interno del database. Questo salvataggio deve essere automatico. Nel caso in cui tutti e 4 i trainer siano stati completati, senza interruzione alcuna da parte dell'utente, il software deve eseguire una query di inserimento che, in modo assolutamente invisibile per l'utente, memorizzerà all'interno della tabella Risultati il Codice del gioco eseguito, il Nome dell'utente che ha eseguito il gioco, e il risultato. Generazione indice età cerebrale. ID R13 Il software deve generare, in modo automatico e invisibile per l'utente, un indice di età cerebrale che deve poi essere memorizzato nel database mediante una query di aggiornamento sulla tabella Account, del campo Età Cerebrale. Questa generazione deve essere effettuata ogni volta che l'utente conclude correttamente un trainer, in accordo con i risultati ottenuti. Questo indice deve essere mostrato nell'interfaccia di Gestione Account. Generazione grafici. ID R14 All'interno dell'interfaccia di Gioco, deve essere disponibile un bottone con etichetta Grafici, al cui clic deve essere mostrata un'interfaccia Grafici in cui devono essere visualizzati grafici, generati automaticamente dal software, relativi ai risultati ottenuti nei vari giochi, e all'andamento dell'indice di Età cerebrale, tenendo conto dell'età dell'utente e del livello. Generazione reports. ID R15 All'interno dell'interfaccia Grafici, deve essere presente un bottone con etichetta Genera Reports, al cui clic deve generare dei reports di statistiche tenendo conto dei valori mostrati nei grafici, e deve salvarli in un file in formato CSV, comma separated values, così da essere compatibile con le più comuni suite office. Il nome del file sarà nel formato, NomeUtente Data.cvs, e sarà salvato all'interno di una cartella, Reports, creata all'interno della cartella in cui si trova il gioco. Proposta automatica dei trainer. ID R16 Nella modalità Allenamento il software deve proporre 4 trainer, che devono essere generati automaticamente, in base al livello dell'utente. I trainer messi a disposizione devono essere: Trainer per la memoria Pagina 6 9

7 Trainer matematici Trainer di logica Trainer lessicali Giochi per la memoria. ID R17 Il gioco messo a disposizione per allenare la memoria deve essere: Memory. All'avvio di questo gioco devono essere mostrate all'utente un certo numero di carte, in base al livello dell'utente. Le carte devono raffigurare dei simboli. Ogni simbolo deve essere raffigurato solamente su due carte distinte. Dopo qualche secondo le carte devono essere coperte e l'ordine cambiato. Le carte devono essere cliccabili. Al clic, la carta deve mostrare il simbolo che essa raffigura. Rimanendo scoperta, l'utente cliccherà su una seconda carta. Quest'ultima scoprendosi mostrerà il proprio simbolo. Se i due simboli sono uguali, le due carte devono essere marchiate con una X sopra, altrimenti le due carte tornano coperte e il gioco prosegue così come descritto. Giochi per le capacità matematiche. ID R18 Il gioco messo a disposizione per allenare le capacità matematiche deve essere: Fast. Il software deve proporre all'utente una serie di somme e sottrazioni, di difficoltà crescente in base al livello. All'interno dell'interfaccia di questo gioco, deve essere presente, di volta in volta, una Label che mostrerà il quesito proposto e 4 bottoni le cui etichette saranno i quattro possibili risultati messi a disposizione dell'utente. Ogni volta che l'utente clicca su uno dei 4 bottoni, il software deve controllarne, in modo automatico e invisibile, l'etichetta e verificare se contiene il risultato corretto al quesito. Se ciò avviene il software deve registrare temporaneamente il progresso. In ogni caso il software deve proseguire nell'esecuzione proponendo i quesiti successivi. Giochi per le capacità logiche. ID R19 Il gioco messo a disposizione per allenare le capacità logiche deve essere: Sudoku. Il software deve implementare una funzione che generi in modo automatico uno schema corretto di Sudoku, e la sua soluzione. Il gioco consiste in uno tabella 3x3. Ogni cella deve contenere a sua volta una tabella 3x3, ottenendo così uno schema di 81 celle. Il software deve gestire l'inserimento all'interno delle celle di numeri, solo valori da 1 a 9. Il programma deve gestire i conflitti, che nascono nel caso in cui nella stessa riga, colonna o blocco 3x3, siano presenti due numeri uguali. L'utente deve cliccare su una cella per potervi scrivere all'interno mediante tastiera il valore che ritiene vada in quella posizione. Il gioco sarà completato, e i progressi salvati, solo quando l'utente avrà compilato le 81 celle e il software avrà controllato che sia stato rispettato lo schema risolutivo calcolato in fase di generazione. Giochi per le capacità lessicali. ID R20 Il gioco messo a disposizione per allenare le capacità logiche deve essere: Hyphenation Il software deve mostrare all'utente delle parole, più o meno complesse in base al livello, e fornire 4 bottoni le cui etichette devono essere le 4 possibili soluzioni al quesito. L'utente deve Pagina 7 9

8 individuare il numero esatto di sillabe presenti nella parola mostrata, e cliccare sul pulsante corretto. Al clic il software deve verificare che l'etichetta del bottone premuto contenga il valore corrispondente alla soluzione del quesito. In questo caso il software deve memorizzare temporaneamente il progresso. Il software deve comunque proseguire l'esecuzione proponendo all'utente altre parole. Timer di gioco ID R21 I trainer devono essere temporizzati, nella modalità Allenamento. All'avvio dei trainer matematici e lessicali, deve essere inizializzato un contatore con un valore pari a 2 minuti. Il timer inizierà il conto alla rovescia, e quando finirà il software deve interrompere il trainer. In questo arco di tempo l'utente deve risolvere quanti più quesiti è possibile. All'avvio dei trainer di memoria e logica invece, deve partire un timer che registrerà lo scorrere del tempo dalla proposta del gioco fino al suo completamento, e che deve interrompere immediatamente il gioco, invalidando il trainer, se questo tempo supera i 15 minuti. Il tempo impiegato a risolvere i due trainer, verrà utilizzato nel calcolo del risultato. Calcolo del livello di difficoltà ID R22 Il software provvede in automatico alla generazione del livello di difficoltà che avranno i giochi proposti all'utente, in funzione del suo indice di età cerebrale Questo valore deve essere memorizzato nel database, nella tabella Account, e mostrato nell'interfaccia di gestione dell'account. Tabella di tracciabilità dei requisiti ID Requisiti R1 R2 R3 R4 R5 R6 R7 R8 R9 R10 R11 R12 R13 R14 R15 R16 R17 R18 R19 R20 R21 R22 R1 U R2 D R3 D U U U U U R4 D R5 D R6 D R7 D R8 D U U U R9 D U R10 D U R11 D D D D D R12 R13 D U U U U U R14 U U R15 U U R16 D U U U U U R17 U U R18 U U R19 U U R20 U U R21 R22 D D Pagina 8 9

9 3.3.Requisiti di Performance ' Saranno definiti nel piano delle prove 4. Indice 1 Introduzione 1.1 Obiettivo del Documento 1.2 Prospettive del Progetto 1.3 Definizioni, Acronimi e Abbreviazioni 2 Descrizione Generale 2.1 Caratteristiche degli Utenti 2.2 Prospettiva del Prodotto 2.3 Descrizione dei Requisiti Funzionali 2.4 Vincoli Generali 3 Specifica dei Requisiti 3.1 Requisiti di Interfaccia 3.2 Descrizione Dettagliata dei Requisiti Funzionali 3.3 Requisiti di Performance 4 Indice Pagina 9 9