Upload
dangcong
View
262
Download
5
Embed Size (px)
Citation preview
IA4412 – Software Engineering
Team AssignmentFinal Software Delivery
Hans-Petter Halvorsen
Level of complexity in your solution?
Estimated Hours:
270 hours
Someone always tends to make things more complicated than necessary!
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
Short Overview of Software Documentation in General
Requirements Analysis
Design
Implementation
Testing
Maintenance
Planning
Your Softwarewith Documentation
Deployment
SRS
SDD
STD
Code
Installation Guides
User Guides
Gantt Chart
with ER Diagram, UML Diagrams, CAD Drawings
Test Documentation
Software Requirements Specifications
Software Design DocumentsSystem Documenation
Test Plan
Project Planning
End-UserDocumentation
SystemDocumentation
Software Test Documentation
SDPSoftware Development
Plan
Typical Software Documentation
High-Level Requirements and Design Documents
User Manuals
System Documentation
Installation Guides
Test Plans
Test Documentation
Detailed Requirements and Design Documents
ER Diagram (Database)UML Diagrams (Code)
Tim
eStart
Finish
How to Test/What to Test
CAD Drawings, etc.
1. Planning
2. Testing
3. End-user Documentation(The people that shall actually use the software)
Technical Stuff
How to use it
How to install it
Proof that you have tested and that the software works as expected
(The stakeholders, the software team; architects, UX designers, developers)
(QA people)
(Super User/ IT dep.)
WHATHOW
(End User)Proj
ect M
anag
emen
t (Ga
ntt C
hart
, etc
.)
(SRS)(SDD)
(STP)(STD)
Software Development Plan (SDP)
2.Requierements/Design
Documentation is Important!
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
“Traditional School Project” vs. “Real Software Development Project”
One Report with “everything” Software Development Plan
Requirements and Design Documents
System Documentation
Test Documents
Installation Guides
User Guides
One document written by 3-6 students together
Many documents written by different people and intended for different people
Software installed at Customer or Setup available for download/DVD
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!
Process Documentation
Product Documentation
System Documentation
User Documentation
Project Documentation
Software Project Documentation Categories
Project Plan, Gant Chart, Meeting Documents, Requirements & Design documentation, Emails, other kind of Working Documents, etc.
User Manuals, Wikis, Online Help, etc.
Technical Documentation needed in order to install and maintain the software, etc.
Installation Guides
Software Delivery Requirements for Team Assignment in IA4412 Software
Engineering Course
Software Delivery1. 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• Videos (links or embedded videos)• Link to Azure DevOps Project
3. Presentation & Demo (max 30 min/team)
Web Site Example
Presentation (Figures and Text) of your Software Product
Documents and Software available for download (Hyperlinks)
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
Create a similar Web Site for your Product
+++
SDP, SRS/SDD, STP, Test Documents, System Documents,
User Guide(s), Installation Guides(s)...
Link to Azure Web Site
Videos
Documents/Videos:• Software Development Plan (SDP)• Software Requirements and Design (SRD)• Software Test Plan (STP) + Test Documents• System Documentation• User Guide(s)• Installation Guide(s)• ...
Description and Picture(s) of SystemDemo: Link to Azure Web Site
Files:• Installation Files.zip (If you have a Desktop App)
Files needed to install the System.How to install is explained in the Installation Guide(s)Note! For “Read-
only” Documents: Use PDF Format
“Final Report”
Link to Azure DevOps Project
Weather System
“Chapters” and “Appendices” in the “Report”
Document Delivery - RecommendationsExamples of different Documentation:• Process Documentation
– Development Plan (SDP) (#1) (with Gantt Chart, Resources, etc.)– Requirements & Design Document (SRD) (#2)– Test Plan (STP) (#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)
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
Documents
Documents• The Documents should have the Quality of
Technical Engineering Documents (similar to the F1 project and other projects)
Presentation & Demo (max 30 min/team)
• Have the Customer in mind during the presentation• Pretend that this is a real software project and not a school project
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
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:http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
Tips
Sjekk at alt utstyret virker på forhånd og at du er i stand til å bruke det!
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
B. Lund. Lunch. Available: http://www.lunchstriper.no, http://www.dagbladet.no/tegneserie/lunch/
Hans-Petter Halvorsen
University of South-Eastern Norwaywww.usn.no
E-mail: [email protected]: https://www.halvorsen.blog