Software Quality Assurance Plan

Transcription

1 Sftware Quality Assurance Plan fr AnthrpdEST pipeline System Versin 1.0 Submitted in partial fulfillment f the requirements f the degree f Master f Sftware Engineering Prepared by Luis Fernand Carranc M. CIS 895 MSE Prject Kansas State University Spring 2010

2 Table f Cntents 1 Purpse Reference dcuments Management Organizatin Tasks Respnsibilities Dcumentatin Standards, practices, cnventins, and metrics Dcumentatin standards Cding standards Lgic structure standards Data structure standards Cmmentary standards Metrics Reviews and audits Test Prblem reprting and crrective actin Tls, techniques, and methdlgies Cde cntrl Recrds cllectin, maintenance, and retentin Risks... 9

3 1 Purpse The purpse f the present dcument is t specify the prcedures and tasks t be perfrmed t assure the quality fr the MSE prject ArthrpdEST pipeline system. The Sftware Quality Assurance (SQA) plan will cver all the prduct functins that the system will autmate. The pipeline system includes EST analysis requests, jb submissins, ntificatin, reprt generatin, and keep track f analysis dne. The prcedures described in this plan will be applied during inceptin, elabratin, prductin and transitin phases f the develpment f ArthrpdEST pipeline system. 2 Reference dcuments Visin Dcument Prject Plan IEEE Standard fr Sftware Quality Assurance Planning. 3 Management 3.1 Organizatin The peple that will be invlved during the sftware prject develpment t assurance the quality f the system is present belw. Supervisin Cmmittee Dr. Daniel Andresen Dr. Dina Caragea Dr. Mitchell Neilsen Majr Prfessr Page 3

4 Dr. Daniel Andresen Technical inspectrs Tsung-Hsi Wu Carls Kirkcnnel Develper Luis Carranc Biinfrmatics Center technical respnsible Sanjay Chellapilla 3.2 Tasks The activities fr the ArthrpdEST pipeline system are defined in the Prject Plan dcument. Hwever, the mst imprtant tasks t assure quality ver the system include: Frmal reviews will be perfrmed thrugh majr prject milestne which include the three MSE presentatins at the end f inceptin, elabratin and prductin phases. Testing will be dne during the whle life-cycle accrding t the planning that will be dne in the inceptin and elabratin phase. Perfrmance metrics will be cllected and analyzed thrughut the life-cycle, but mainly in prductin and transitin phase, where they will be mre accurate. 3.3 Respnsibilities The supervisin cmmittee will be respnsible fr review the system in the presentatins at the end f each phase. After each presentatin, the cmmittee will prvide feedback t the develper regarding the sftware prduct. The majr prfessr will be respnsible fr supervising the tasks and prgress dne by the develper during the prject develpment. Page 4

5 The frmal technical inspectrs will be respnsible fr a technical review ver the architecture design system and particularly ver the frmal dcumentatin generated fr the prject. They will prduce an inspectin reprt with feedback fr the develper. The develper will generate all the prject dcumentatin and perfrm all develpment tasks in rder t achieve the gals and requirements defined in the Visin Dcument. Additinally, develper will be n charge f the sftware testing and prepare the presentatins befre the cmmittee. The Technical respnsible frm Biinfrmatics Center will verify the crrectness f results which are prduced by the biinfrmatics packages in the pipeline system. 4 Dcumentatin The deliverable dcuments that will be prduced during the develpment f the system are: Visin Dcument Prject plan dcument with wrk breakdwn structure Sftware quality assurance plan Architectural design dcument Frmal specificatin Test plan Technical inspectin reprts Assessment evaluatin User Manual Prject evaluatin Page 5

6 Dcuments shuld be crss referenced between them. They will be reviewed and apprved by the cmmittee, and they shall be cnsistent with requirements and functinality. All dcumentatin will be psted by at the web site 5 Standards, practices, cnventins, and metrics 5.1 Dcumentatin standards IEEE standards will be used as a main guideline fr all prject dcumentatin. UML diagrams will be used as much as pssible t depict visually the sftware prduct. Critical requirements will be shwn thrugh use cases. Sequence and class diagrams will be the standards fr design dcumentatin. 5.2 Cding standards The new sftware cmpnents t be develped fr the prject will be cded using pythn. Pythn Enhancement Prpsal (PEP) number 8 will be used as cding standards. The administratin interface will be develped in PHP and its cde standard will be used. Fr the cmpnents already develped, it will be used Perl and Bash shell cding standards. 5.3 Lgic structure standards Cde files will be hierarchically in packages and mdules t rganize the cmpnents structure. It will be used bject riented prgramming t define classes in files. 5.4 Data structure standards Mysql name standards will be used fr the system database structure. Table names will start with uppercases, and field names with lwercases. Camel case will be the standard fr names f fields with mre than ne wrd. 5.5 Cmmentary standards Page 6

7 All the new sftware cmpnents t be develped will be cmmented t give a brief descriptin f the cde fcusing in the main purpse f the functinality. Every mdule, class, and methd will be cmmented describing the main purpse f the cde. Fr each file, a main header cmment shall be cntain the authr s name, creatin date, last mdificatin date, and brief descriptin f its purpse. 5.6 Metrics Metrics will help t measure the prgress f the sftware prject. Sme metrics t be taken during the prject t future evaluatin are lines f cde (LOC), number f test failures, develpment and test hurs. At the end f the prject, the effrt will be evaluated accrding t initial estimatins. 6 Reviews and audits The majr reviews will be dne at the three frmal presentatins at the end f each phase. The cmmittee members will prvide feedback and suggestins accrding t the prduced dcumentatin as well as the prttype demnstratins. Furthermre, the tw frmal technical inspectrs will assess the architecture design alng the frmal specificatins t submit a reprt based n their findings. Finally, the Biinfrmatics Center s technical respnsible will verify that the results fr the EST analysis will be prduced crrectly fr the new implementatin f the pipeline system. 7 Test A test plan will be develped defining test activities and functins t be verified in the system. All the results must be dcumented and evaluated. 8 Prblem reprting and crrective actin Page 7

8 All parties invlved in the prject shuld reprt any prblem with the sftware system, artifacts r the prcess itself as sn as pssible. The develper shuld be respnsible fr prvide slutins and time estimatin t reslving the prblems. The majr prcessr shuld review that the crrective actin will be applied after any reprted issue. All the prblems will be dcumented as part f the final prject evaluatin dcument indicating which the prblem was and hw it was slved. If there is any unreslved prblem, it shall be directly reprted t the cmmittee members. 9 Tls, techniques, and methdlgies Tls that will be used during the prject develpment t assure the quality are: MS Wrd. Develp dcumentatin MS Prject. Prject planning and keep track prgress. MS Visi. UML dcumentatin Eclipse. Supprt prject develpment, cmpile cde Pythn Unit. Fr unit testing Virtual Bx. Fr server test envirnment. USE. Frmal specificatin and verificatin Subversin. Keep surce cde repsitry and cntrl versining Techniques Presentatins Frmal inspectins Methdlgies Iterative mdern prcess Page 8

9 10 Cde cntrl The subversin surce repsitry system will be used fr cde cntrl f the ArthrpdEST pipeline system surce and testing cde. 11 Recrds cllectin, maintenance, and retentin All the dcumentatin and surce cde prduced will be recrded and versined. This includes the detail dcumentatin f the design, implementatin and the testing data. This wuld certainly help the develper s t extend, mdify r repair the sftware in future. At the end f the prject, the final versin f the dcumentatin will be turn in t the University Library, majr prfessr, Develper and Biinfrmatics Center. The entire surce cde will be submitted in a CD t the majr prfessr and Biinfrmatics Center. 12 Risks Ptential risks will be identified and they will be cnstantly mnitring thrugh a table risk management t mitigate their impact. The identified risks fr the ArthrpdEST pipeline system are described in the table belw. Risk Level Impact Mitigatin Cntingency Incmpatibility High Prject Early prttype identifies Install supprted sftware biinfrmatics packages unfeasibility cnfiguratin and prgrams in Becat cluster in Becat Becat supprts ArthrpdEST pipeline Medium Prject Test early prttype directly Identify cde t adjust. scripts d nt execute in Becat delay in Becat Estimate time and decide which functinality mdify. Requirements creep Medium Prject Review early prttype with Cmmittee members in the delay Biinfrmatics Center presentatins decide which technical respnsible reach new requirements might be Page 9

10 Perfrmance degradatin Lw Prject s gals nt reached main gals. Measure time respnses during prject develpment and cmpare with ld implementatin. implemented. Identify bttlenecks, estimate time and decide sectins t be changed. Page 10