project_template

advertisement
Authors
Table of contents
1. Context for the designed system - description of the department/area of planned
system application
2. System requirements identification and description
3. Functional scope – functional structure of the system
4. List and description of system users – user/function table
5. System functions modeling - use case diagram (with use case scenarios)
6. Information structures modeling – class diagram
7. System operation modeling – activity diagrams (for at least 2 use cases)
8. Interaction models - sequence diagrams (for at least 2 use cases)
9. Design of the database from class diagram (physical data model)
10. Design of a windows form user interface (a), or a web form user interface (b)
a) design of the main window, 2 input windows, 2 output windows with a
detailed description;
b) design of the main page and 4 subpages with a detailed descriptions
1. Context for the designed system - description of the department/area of
planned system application
A few words about the profile of the organization and the kind of services it provides. Detailed
description of the department / area of business activity for which the IT system will be designed.
What is the goal of the system – what needs is it supposed to satisfy, what activities (operations) is
it supposed to support? How can an information system help to reach the organization goals.
2. System requirements identification and description
Description of general requirements for the system – main tasks of the system (what will the
system generally support)
Description of functional requirements – system functions, data (input and output data), system
users (who will use it and for what purpose)
Description of non-functional requirements – quality requirements (safety, reliability etc.),
interface requirements
Description of environment requirements – architectural (hardware, software), performance and
documentation, standards and interfaces to other systems (if applicable)
Description of design and implementation requirements – cost and time limits, development
environment (if applicable), methods of validation and testing
3. Functional scope – functional structure of the system
1. Function 1
2. Function 2
3. Function 3
3.1. Subfunction of Function 3
3.2. Subfunction of Function 3
4. Function 4
5. …..
4. List and description of system users – user/function table
System users (roles)
System functions
Function 1
Function 2
Function 3
Subfunction of Function 3
Subfunction of Function 3
Function 4
…..
User 1
User 2
User 3
…..
5. System functions modeling – use case diagrams with specification
Order service system
Supply catalogue
initiates
Check order status
initiates
Client
initiates
uses
Update account
Cancel order
<<include>>
Finance system
initiates
<<include>>
<<include>>
Place order
<<include>>
Update goods quantity
uses
<<include>>
initiates
Sales representative
uses
Collect goods data
Prepare sales report
Warehouse system
<<include>>
initiates
<<include>>
Collect goods from suppliers
uses
Prepare and send ordered products
initiates
Delivery company
* The scenarios of all use cases should be written underneath the diagram.
Employee
6. Information structures modeling – class diagram
Member
# Member Number : int
# Member Name
: String
# Member Address : String
+ change Name ()
: void
+ change Address () : void
<<actor>>
Club Member
<<actor>>
Past Member
- Membership expiration Date : Date
Product
#
#
#
#
#
#
Product Number
Quantity In Stock
Product Type
Unit Price
Current Month Units Sold
Current Year Units Sold
:
:
:
:
:
:
String
int
String
Double
int
int
1..1
-
Member Date Of Last Order
Member Phone Number
Member Credit Card Expire Date
Member Credit Card Number
Member Credit Card Type
Member Balance Due
Audio Category Preference
Video Category Preference
Game Category Preference
E-mail Address
Date Enrolled
+
+
+
+
change Phone Number ()
display Balance Due ()
change Preferences ()
add Club Member ()
:
:
:
:
:
:
:
:
:
:
:
:
:
:
:
Date
String
Date
String
String
Double
String
String
String
String
Date
Agreement
binds
1..1
void
void
void
ClubMember
Agreement Number
Agreement Expire Date
Agreement Active Date
Required Number Of Credits
conducts
Transaction
Transaction
Transaction
Transaction
Transaction
Reference Number
Date
Type
Description
Amount
0..*
Member Ordered Product
Merchandise
-
Merchandise Name
Merchandise Description
Merchandise Type
Unit Of Measure
:
:
:
:
-
String
String
String
String
Quantity Ordered
Quantity Shipped
Purchase Unit Price
Credits Earned
:
:
:
:
places
int
int
Double
int
Return
0..*
0..*
Title
#
#
#
#
#
#
Title Of Work
Title Cover
Catalog Description
Copyright Date
Entertainment Company
Credit Value
:
:
:
:
:
:
String
String
String
Date
String
int
Member Order
0..1
consists of
-
Order Number
: int
Order Creation Date
: Date
Shipping Address Name
: String
Order Sub Total
: Double
Order Sales Tax
: Double
Order Shipping Method
: String
Order Shipping & Handling Cost : Double
Order Prepaid Amount
: Double
Order Prepayment Method
: String
+ change Shipping Method () : void
+ calculate Prepaid Amount () : Double
Video Title
Audio Title
-
Artist
:
Audio Category
:
Number Of Units In Package :
Audio Media Code
:
String
String
int
int
+ add Audio Title () : AudioTitle
-
Producer
Director
Video Category
Language
Video Media Type
Video Encoding
Screen Aspect
:
:
:
:
:
:
:
String
String
String
String
String
String
String
+ add Video Title () : VideoTitle
Game Title
-
String
Date
Date
int
Transaction
#
#
#
#
#
0..*
sold as
:
:
:
:
+ change Expire Date () : void
1..1
1..1
+ change Quantity In Stock ()
: void
+ calculate Current Month Units Sold () : int
+ calculate Year Units Sold ()
: int
1..*
Manufacturer
Game Category
Game Platform
Game Media Type
Number Of Players
:
:
:
:
:
String
String
String
String
int
+ add Game Title () : GameTitle
:
:
:
:
:
int
Date
String
String
Double
7. System operation modeling – activity diagrams
Name of the use case the diagram corresponds to, for example “Book rental”
* For at least 2 use cases
8. Interaction models - sequence diagrams
Name of the use case the diagram corresponds to, for example “Making room reservation”
IReservation
:AvailableRooms
Receptionist
1: openReservation
2: checkAvailableRooms
3: displayAvailableRooms
4: insertReservationData
5: makeReservation
6: confirmation
7: closeReservation
8: displayMenu
* For at least 2 use cases
:Reservation
9. Design of the database from class diagram (physical data model)
Client
ClientID
Street
HouseNo
FlatNo
City
PostalCode
Email
Telephone
varchar(254) <pk>
varchar(254)
varchar(254)
varchar(254)
varchar(254)
varchar(254)
varchar(254)
varchar(254)
Individual
Company
ClientID
varchar(254) <pk,fk>
SecondName varchar(254)
FirstName
varchar(254)
ClientID
varchar(254) <pk,fk>
Name
varchar(254)
IdentificationNo varchar(254)
Order
OrderNo
ClientId
OrderDate
RealizationPeriod
RealizationDate
GrossValue
varchar(254) <pk>
varchar(254) <fk>
timestamp
varchar(254)
timestamp
float
Order Item
ProductCode
OrderNo
Quantity
Discount
varchar(254) <pk,fk1>
varchar(254) <pk,fk2>
integer
float
Product
Cateogry
CategoryID
varchar(254) <pk>
CategoryName varchar(254)
Status
smallint
ProductCode
SetCode
CategoryID
Name
NetPrice
VATRate
MeasureUnit
Description
Status
varchar(254) <pk>
varchar(254) <fk2>
varchar(254) <fk1>
varchar(254)
float
smallint
varchar(254)
varchar(254)
smallint
10. Design of a user interface
Detailed descriptions of the functionality of window forms/webpages.
* In case of widows form interface - main window, 2 input windows, 2 output windows
* In case of web form interface - main page and 4 subpages
Download