Team Assignment. Final Software Delivery. IA4412 Software Engineering

Transcription

1 IA4412 Software Engineering Team Assignment Final Software Delivery B. Lund. Lunch. Available: Hans-Petter Halvorsen, M.Sc.

2 Level of complexity in your solution? Someone always tends to make things more complicated than necessary! Estimated Hours: 270 hours B. Lund. Lunch. Available:

3 Short Overview of Software Documentation in General

4 STD System Documentation Testing Software Test Documentation Test Plan Test Documentation Implementation Code System Documenation End-User Documentation User Guides Deployment Maintenance Your Software with Documentation Design Installation Guides SDD Planning SDP Software Development Plan Project Planning Gantt Chart Requirements Analysis SRS Software Requirements Specifications Software Design Documents with ER Diagram, UML Diagrams, CAD Drawings

5 Project Management (Gantt Chart, etc.) Time Typical Software Documentation Start Finish 1. Planning 2.Requierements /Design (The stakeholders, the software team; architects, UX designers, developers) 2. Testing (QA people) 3. End-user Documentation (The people that shall actually use the software) Software Development Plan High-Level Requirements and Design Documents Detailed Requirements and Design Documents Test Plans Test Documentation System Documentation Installation Guides User Manuals (SDP) WHAT HOW ER Diagram (Database) UML Diagrams (Code) CAD Drawings, etc. How to Test/ (STP) What to Test (STD) Proof that you have tested and that the software works as expected Technical Stuff (Super User/ IT dep.) How to install it How to use it (End User) (SRS) (SDD)

6 Documentation is Important! B. Lund. Lunch. Available:

7 Traditional School Project vs. Real Software Development Project One Report with everything One document written by 3-6 students together Does the system works? Hopefully but never used or tested by the reader (or the students?) The software is the heart and needs to work properly otherwise the customer cannot use it and will not pay for it! Software installed at Customer or Setup available for download/dvd Software Development Plan Requirements and Design Documents System Documentation Test Documents Installation Guides User Guides Many documents written by different people and intended for different people

8 Software Project Documentation Categories Project Documentation Process Documentation Project Plan, Gant Chart, Meeting Documents, Requirements & Design documentation, s, other kind of Working Documents, etc. Product Documentation System Documentation Technical Documentation needed in order to install and maintain the software, etc. Installation Guides User Documentation User Manuals, Wikis, Online Help, etc.

9 Software Delivery Requirements for Team Assignment in IA4412 Software Engineering Course

10 Software Delivery 1. Install/Deploy Software to Production Environment ready for Demo (-> Microsoft Azure) 2. Web Page Presentation/overview of the Software Product (Text + Images) Downloadable Documents (PDFs) (Hyperlinks), SDP, SRD, STP,... Downloadable Software (Installation Files) and/or link to your Software hosted in Microsoft Azure Downloadable TFS/VSO contents (everything!) as a ZIP File 3. Presentation & Demo (max 30 min/team)

11 Web Page

12 Web Site Example Link til Azure Web Site Create a similar Web Site for your Product Presentation (Figures and Text) of your Software Product Note! We should use only HTML (not ASP.NET! because the Web Server we are using at school dont support it). In addition you may use JavaScript, CSS, PHP Documents and Software available for download (Hyperlinks) +++ SDP, SRS/SDD, STP, Test Documents, System Documents, User Guide(s), Installation Guides(s)... VSTS.zip

13 Final Report Chapters and Appendices in the Report Note! For Readonly Documents: Use PDF Format Weather System Description and Picture(s) of System Demo: Link to Azure Web Site VSTS: Link to VSTS Project Documents: Software Test Plan (STP) Software Requirements and Design (SRD) Software Test Plan (STP) + Test Documents System Documentation User Guide(s) Installation Guide(s)... Files: Installation Files.zip VSTS.zip Files needed to install the System. How to install is explained in the Installation Guide(s) Everything you have created in VSTS (Code, Original Documents, etc..)

14 Document Delivery - Recommendations Examples of different Documentation: Process Documentation Development Plan (#1) (with Gantt Chart, Resources, etc.) Meeting documentation (included in VSO) Requirements & Design Document (#2) Test Plan (#3) (how to test, etc.) & Test Documentation (#3b) (Test results, etc) Product Documentation System Documentation (#4) How the System Works (Technical), i.e. use the Requirements & Design as base. Requirements & Design is about how it should be, while System Documentation is about how it became Includes Technical Design and Platform Overview, Database Diagram, UML diagrams, CAD drawings, Code Documentation, Flow Charts, with explanations, etc. How to deploy (how to install server-side logic), maintain, etc. User Documentation Installation Guide (#5) (you may include it as part of User Manual and/or System Documentation) User Manual(s) (#6)

15 Documents B. Lund. Lunch. Available:

16 Documents The Documents should have the Quality of Technical Engineering Documents (similar to the F1 project and other projects) You should read Veileder for Prosjektarbeid located

17 Presentation & Demo (max 30 min/team) B. Lund. Lunch. Available: Have the Customer in mind during the presentation Pretend that this is a real software project and not a school project

18 Tips The contents of the weekly assignments reflect what is important with regards to the assessment and grading Pretend that this is a real software project and not a school project. This means that you should not write This is a school project..., We learned a lot..., etc. The different documents should be written for an imaginary Customer in mind (not the teacher) Same with Presentation and Demo (have the Customer in mind) B. Lund. Lunch. Available:

19 Tips B. Lund. Lunch. Available: Sjekk at alt utstyret virker på forhånd og at du er i stand til å bruke det!

20 B. Lund. Lunch. Available:

21 B. Lund. Lunch. Available:

22 Hans-Petter Halvorsen University College of Southeast Norway Web: Blog: