1(10)
Group no.
Course CD5360, Software Engineering
Date
Proj. mgr.
E-mail
Requirements Definition
Project: Vasa ship
DISTRIBUTION
Everything will be distributed via the CVS system.
Steering group:
Andreas Sjögren
Rikard Land
Project group:
Los Polizones:
Jari Ala-Kurikka
Gisèle Mwepu
Lars Berglind
Tommy Helsing
Madeleine Gåse
Bjarne Johansson
Carl-Henrik Pettersson
Rosa Tortajada Muñoz
1 - Los Polizones
2016-03-06
Jari Ala-Kurikka
Jaa99001@student.mdh.se
2(10)
Course CD5360, Software Engineering
Group
no.
1 - Los Polizones
Date
2016-03-06
CONTENTS
1
2
3
Introduction .......................................................................................................... 3
1.1
Background ................................................................................................. 3
1.2
General Description .................................................................................... 3
1.3
Definitions .................................................................................................. 3
1.4
Related Documents ..................................................................................... 3
Requirements........................................................................................................ 3
2.1
Use case model ........................................................................................... 5
2.2
Requirements Specification ........................................................................ 7
Future Development (TBD) ................................................................................. 9
3(10)
Course CD5360, Software Engineering
1
1.1
Group
no.
1 - Los Polizones
Date
2016-03-06
Introduction
Background
The customer wants a homepage with information about the vasa ship and the
possibilities to run simulations of how the ship capsized. This document specifies the
requirements on the product.
1.2
General Description
The main task is to make a web page about the Vasa ship. The web page shall contain
a nice presentation about the ship and a description why the ship capsized. This will be
illustrated with a simulation. The simulation will also show ships stability. It shall also
be possible to build and equip your own “Vasa ship”.
1.3
Definitions
Terms
Ship
Vasa ship
1.4
Related Documents
Document identity
Project description
2
Definitions
Includes the attributes:
 Cannons (+ number of)
 Ammunition (+ number of)
 ballast (+ amount)
 decks (+ number of)
 Masts with sails (+ area)
 Crew (+ number of)
Is influenced by:
 Gravity (at center of gravity)
 Buoyancy (at center of buoyancy)
 Wind power
Same as Ship, but it has predefined values for all
attributes.
Document title
Project_description.doc
Requirements
System Requirements
1. The system shall be designed in a way that makes it easy to update and easy to
use.
Web page
1. The web page shall contain background information about the Vasa ship.
4(10)
Course CD5360, Software Engineering
Group
no.
1 - Los Polizones
Date
2016-03-06
2. The web page shall contain a description of the structure and layout of the
ship.
3. The web page shall contain description of why the Vasa ship capsized.
4. The web page shall be linked to the simulation application (see specification
below), which shall be runnable over the internet without further
downloading.
5. The web page shall be linked to the interactive simulation application (see
specification below), which shall be runnable over the internet without further
downloading.
Interactive Simulation
1. The application shall allow the user to configure a ship and test it’s stability.
2. The applications shall calculate the stability of the ship based on the values of
the number of decks, number of canons, weight of the ballast, amount of
ammunition, wind power.
3. The user of the application shall be able to configure the following attributes:
number of decks, number of canons, weight of the ballast, amount of
ammunition, wind power.
4. The application shall present a graphical visualization of the result of the
calculation.
Vasa Ship Simulation
1. The application shall present a visual simulation of how the Vasa ship
capsized.
2. The application shall contain a textual explanation of why the Vasa ship
capsized.
5(10)
Course CD5360, Software Engineering
2.1
Group
no.
1 - Los Polizones
Date
2016-03-06
Use case model
Read description
Read background
User
Run Vasa Simulation
Build Vasa Ship
Read Description
Name:Read Description
Initiator: WebClient
Goal: To read vasa ship's description on the web page
Main Scenario:
1. WebClient chooses the "Description " option
2.The System goes to The Description's link-page
3. WebClient reads the description
4. WebClientchooses the "Close" option
5.The System closes the Description
Extensions:
3.WebClient doesn't want to read
a.WebClient chooses the "Close" option
6(10)
Course CD5360, Software Engineering
Group
no.
1 - Los Polizones
Date
2016-03-06
Read Background
Name:Read Background
Initiator: WebClient
Goal: To read vasa ship's background on the web page
Main Scenario:
1. WebClient chooses the "Background " option
2.The System goes to The Background's link-page
3. WebClient reads the Background
4. WebClientchooses the "Close" option
5.The System closes the Background
Extensions:
3.WebClient doesn't want to read
a.WebClient chooses the "Close" option
Run Vasa Simulation
Name: Run Vasa Simulation
Initiator: User
Goal: To run a simulation of how the Vasa ships capsized
Main Scenario:
1. User starts the simulation
2. The system runs the simulation application
Extensions:
2. The system cannot run the simulation
a) Fail
Build Vasa Ship
Name: Build Vasa Ship
Initiator: User
Goal: Build interactive vasa ship
Main Scenario:
1. The user enters the interactive application.
2. The user builds the ship.
7(10)
Course CD5360, Software Engineering
Group
no.
1 - Los Polizones
Date
2016-03-06
3. The user checks if the ship
he/she has built is stable and sailable with the selected windpower.
4. The user exit the interactive application.
Extensions:
2. The system cannot run the interactive application.
a) Fail
2.2
Requirements Specification
Terms
SR
IS
VSS
WP
Customer
Identity
WP
WP-1
Prio.
WP-2
1
WP-3
1
WP-4
1
WP-5
1
1
Definitions
System Requirements
Interactive Simulation, application which allows user
to configure a ship and calculate stability.
Vasa Ship Simulation, application which presents a
visual explanation of why the Vasa ship capsized.
Web Page, the main web page which holds general
information and the IS and VSS.
Ivica Crnkovic
Description
Web page
Background information
Definition: The web page shall contain background information
about the Vasa ship.
Motivation: The user may want historical information about the
Vasa ship.
Ship structure
Definition: The web page shall contain a description of the
structure and layout of the ship.
Motivation: The user may want information about how the Vasa
ship was constructed and what it looked like.
Reason why the ship capsized
Definition: The web page shall contain description of why the
Vasa ship capsized.
Motivation: The user may want information about which factors
that caused the ship to capsize.
Link to Simulation Application
Definition: The web page shall be linked to the simulation
application (see specification below), which shall be runnable over
the internet without further downloading.
Motivation: Link is needed in order to access the Simulation
Application from web page.
Link to Interactive Simulation Application
Source
Customer
Customer
Customer
System
structure
System
8(10)
Course CD5360, Software Engineering
IS
IS-1
1
IS-1.2
1
IS-1.2.1
1
IS-2
1
VSS
VSS-1
1
VSS-2
1
SR
SR-1
1
SR-1.1
1
Group
no.
1 - Los Polizones
Date
2016-03-06
Definition: The web page shall be linked to the interactive
simulation application (see specification below), which shall be
runnable over the internet without further downloading.
Motivation: Link is needed in order to access the Interactive
Simulation Application from web page.
Interactive simulation
Calculation
Definition: The applications shall calculate the stability of the ship
based on the values of the number of decks, number of canons,
weight of the ballast, amount of ammunition, wind power.
Motivation: The calculation has to be performed in order to decide
the stability of the user configured ship.
Configuring ship
Definition: The application shall allow the user to
configure a ship and test it’s stability.
Motivation: In order to make a calculation, the application
needs input.
Configurable attributes
Definition: The user of the application shall be
able to configure the following attributes: number
of decks, number of canons, weight of the ballast,
amount of ammunition, wind power.
Motivation: The attributes above can be altered to
make a user specific ship configuration, which can
be tested.
Graphical Presentation
Definition: The application shall present a graphical visualization
of the result of the calculation.
Motivation: The result shall be presented in an easy
understandable way.
Vasa Ship simulation
Vasa Simulation (=IS-2 with Vasa warship-specific values)
Definition: The application shall present a visual simulation of
how the Vasa Ship capsized.
Motivation: The user may want to see the reason why the Vasa
ship capsized.
Textual Explanation
Definition: The application shall contain a textual explanation of
why the Vasa ship capsized.
Motivation: To support the visual simulation in explaining the
points of failure in the structure of the Vasa ship.
System requirements
Modifiability and Usability
Definition: The system shall be designed in a way that makes it
easy to update and easy to use.
Motivation: It shall be easy to add new functionality.
Modifiability
Definition: The following should be followed in order to
ensure easy update and change:
 Modularised code
structure
Customer
Customer
Customer
Customer
Customer
Customer
Customer
Customer
9(10)
Course CD5360, Software Engineering





SR-1.2
3
1
Group
no.
1 - Los Polizones
Date
2016-03-06
Well commented code
Readable code
Use generic programming, not applicationspecific
Continuing update of all related documents
Correct use of an object-oriented language
Usability
Definition: The user must always:
 Know what the system is doing (status)
 Be presented with information in a uniform way
 Experience the system as self-explanatory
 Easily access relevant help
 Get the service that he/she expected
 Experience that the system looks pleasant
Customer
Future Development (TBD)
Interactive Simulation
1. User may change the wind power during simulation.
2. When canons are fired the ballast decreases due to the loss of ammunition.
3. Different sizes of canons.
10(10)
Course CD5360, Software Engineering
REVISION
Rev.
ind.
Jaa99001
Jaa99001
Jaa99001
Jaa99001
Page (P)
Chapt.(C)
P1
P3
Whole doc
P3, P7
Jaa99001
Jaa99001
P7-9
P9
Group
no.
1 - Los Polizones
Date
2016-03-06
Description
Added information about file distribution
Added a related document
Changed should to shall everywhere
Moved definitions from P3 to P7, Wrote new definitions
concerning the ships
Re-organized the Requirements specification. (Logical order)
Added sub-requirements to the Modifiability and Usability
section.
Date
Initials
2002-03-26
2002-03-26
2002-04-04
2002-04-04
2002-04-04
2002-04-04