guide for writing a project proposal - software engineering ii web viewplay sound: this function...

40
King Saud University College of Computer and Information Sciences Information Technology Department CAP312 Project -Phase3- System Design Document –SDD- وة ط خ ب وة ط خ.. ي ف ر حPrepared by Supervised by

Upload: tranminh

Post on 05-Feb-2018

218 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

King Saud UniversityCollege of Computer and Information Sciences

Information Technology Department

CAP312 Project -Phase3-System Design Document –SDD-

خطـوة.. حـــرفيبخطــــــــــــوة

Prepared by

Supervised by

Second Semester Spring

Page 2: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

TABLE OF CONTENTS

Analysis......................................................................................................................................................3

1.1 Context Diagram.......................................................................................................................................3

1.2 DFD Diagram...............................................................................................................................................4

Design Introduction...................................................................................................................................5

SYSTEM OVERVIEW....................................................................................................................................6

sYSTEM ARCHITECTURE.............................................................................................................................7

DETAILED SYSTEM DESIGN.........................................................................................................................8

DATA DESIGN...........................................................................................................................................16

ER.......................................................................................................................................................................... 16

Attribute Dictionary......................................................................................................................................16

User interface design...............................................................................................................................17

User interface design overview...............................................................................................................17

User interface navigation hierarchy......................................................................................................17

User function (or use cases) Interfaces................................................................................................18

Team management..................................................................................................................................28

Tasks Distribution:........................................................................................................................................28

Revision:.............................................................................................................................................................28

References...............................................................................................................................................30

Page 2

Page 3: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

ANALYSIS

1.1 CONTEXT DIAGRAM

Figure.1 Context Diagram

Page 3

Page 4: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

1.2 DFD DIAGRAM

Figure.2 DFD

Page 4

Page 5: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Page 5

Page 6: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

DESIGN INTRODUCTION

..............................................

....................... of the implemented application. In addition, flaws and problems corrected early in the development effort minimize impact to a project’s schedule and budget.[1]

The system design specification or software design specification as referred to have a primary audience, ...............................

This document includes details of our project system architect which the system and/or subsystem(s) architecture for the project, ...............................

The software shall use two kinds of voices that, shows how's the letter is pronounced not the name of the letter, to simulate a teacher’s voice and the other to simulate a student's voice, the software also should be distraction-free and that is by using an interface that attract the attention with taking into consideration that LDs students tend to lose their attention really quickly so no animations nor bright colors are used. It also should commit to the doll's restriction which was specified by the client and to make the software run faster, the audio and image files should be small in size

Page 6

Page 7: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

SYSTEM OVERVIEW

Dealing with elementary students who suffer from learning disabilities requires us to be more careful in many points. And what we focus on is building accessible distraction free software using specific methods based on standards for this category of people without neglecting their age demands that include attractive and cheerful objects. Also connecting between their real life environment and education methods is something we paid attention to, by pronouncing the letter with different “Harakat”, using images for the lesson showing the different position for writing the letter, and also making the lessons revision with the “Place on the Doll” game.

In general our software is very simple to use, because of buttons with meaningful logos and guides, and a separate page for every activity.

Page 7

Page 8: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

SYSTEM ARCHITECTURE

The figure shows the application structured into three layers. The presentation layer is concerned with presenting information to the user and with all user interactions. The application processing layer is concerned with implementing the logic of the application, and data management layer is concerned with all database application. We have not used the client-server model.................., we do not use network ......................... ....................................................., that’s why we did not use the repository model.

FIGURE.1 SYSTEM ARCHITECTURE

Page 8

Page 9: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

DETAILED SYSTEM DESIGN

.....................................................

.....................................................

Choose Letter to Learn

Classification

Function

Definition

The user will be able to choose a letter to start learning, whether from the split or joined letters according to specified order.

Responsibilities' Reference

3

Constraints

Pre condition: there is no chosen letter to proceed to the letter's main page The split letters must all be chosen before the joined letters The user will be able to choose only one letter Post condition: the user will proceed to the program through the chosen

letter Exit button will be provided

Composition

None

Pseudocode

Display the split lettersIF the user have passed all the split letters THEN

Display the join lettersELSE

Display the join letters disabledEND IF

Page 9

Page 10: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

IF the user chose letter THENProceed to the program through this letter

END IFIF the user click Exit THEN

Terminate the programEND IF

Page 10

Page 11: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

........................................

"Place on the Doll" Game

Classification

Subsystem

Definition

It is a revision game, to ensure that the student has mastered the letter, that displays a doll and give the student the ability to identify the components of the doll that start with the learned letter then tag the letter on the matching component.

Responsibilities' Reference

5

Constraints

Pre condition: a letter is chosen by the user. The minimum number of tries to get help is 6 times. The letter –displayed by Help- will remain for 2 minutes. The previously learned letters shall be located on the

appropriate positions of the doll. The doll image must follow the constraints mentioned by the

client. A back button returns to the previous page. The letter is considered of the learned letters for that account,

after passing this game Post condition: the letter is saved as learned for this user

Composition

Help: this function helps the user by displaying the letter on its appropriate location for 2 minutes

Page 11

Page 12: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Pseudocode

Display the current letter, the doll with the user's previously positioned letters, and the game's instructions

Initialize the number of clicks to zero.

Enable the user to choose the appropriate position on the doll

While the user click on the doll

While number of clicks = or less than 6, AND, the user clicked an incorrect location

Increment the number of the clicks.

Notify the user that it is an incorrect location.

End loop

If the user clicks the correct location

Display the current letter on the specified position.

Display a congratulation message to the user.

Add the current letter to the learned-letters in the database.

Disable the user to click on the doll.

Exit the loop

Else if the number of clicks greater than 6

Enable the user to get help

If the user asks for help

Display the letter on its appropriate location for 2 minutes then hide it.

Set the number of clicks to 0.

End if

End if

Page 12

Page 13: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

End loop

If the user asks to go back to the main page

Terminate the game

Display the main page

End if

Page 13

Page 14: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

The Letter Pronunciation Lesson (Umbrella’s model):

Classification

Subsystem

Definition

Lesson for teaching the letter's "Harakat” and how to pronounce it using umbrellas shaped according to the "Haraka" to make it clear.

Responsibilities' Reference

6

Constraints

Pre condition: none It is an optional lesson. The letter should be displayed 3 times, one for each "Haraka". The letter should be displayed first, then the umbrella, shaped

according to the "Haraka", will be shown simultaneously with the teacher's voice played. At last a student voice will repeat the pronunciations of the letter.

A back button should be provided. A mute button must be provided. Post condition: the letter pronunciation page is opened

Composition

Play sound: this function plays the voice of a teacher at the appropriate time Play sound: this function plays the voice of a student at the appropriate time

Page 14

Page 15: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Pseudocode

Choose whether to display umbrellas pictures or faces picturesInitialize count to 0Display 3 images of the letter

IF choose umbrella THENRetrieve the umbrellas imagesDisplay the umbrella's picture (shaped according to the "Haraka") IF voice enabled THENplay the teacher's voiceEND IFIncrement countEND IFIF voice enabled THENPlay student's voiceEND IFIF click back THEN

Close this windowGo to the previous page

END IF

Page 15

Page 16: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

................................

Page 16

Page 17: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

DATA DESIGN

ER

ATTRIBUTE DICTIONARY

Page 17

Page 18: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Page 18

Page 19: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

USER INTERFACE DESIGN

USER INTERFACE DESIGN OVERVIEW

The user interface designers considered how easy our audience are distracted, students with LDs, so it was designed to be distraction free. Also the designer considered their age, so it is supported by colors and images to excite them, and provided instructions and buttons to make it easier for the students to understand, also the login will be performed by the user choosing his/her name from a list. A back button is provided in each page and motivation sentences. The mistakes in the doll game will be handled appropriately and audios are used to accomplish the ease of use.

USER INTERFACE NAVIGATION HIERARCHY

FIGURE.2 UI NAVIGATION HIERARCHY

Page 19

Page 20: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

NOTE: WE WISH TO ADD TWO PAGES IF WE HAVE TIME WHICH FALLS UNDER THE MAIN PAGE. THE TWO PAGES ARE: 1-INTRODUCTION: EXPLAINS THE

MEANING OF EACH BUTTON OF THE UI. 2- ABOUT US.

Page 20

Page 21: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

User function (or use cases) Interfaces

1- Start Page

Figure.3.1 Start Page Print Screen

# Description

1 This button closes the window, and terminates the program

2 This button Restore down or Maximize the window

3 This button Minimize the window

4 This button transfers the user to the Login page, and closes this window

5 This button transfers the user to the Registration page, and closes this page.

Figure.3.2 Start Page Table

The user here chooses whether to Login, if he/she already created an account, or to Register.

Page 21

Page 22: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

2- Login Page

Figure.4.1 Login Page Print Screen

# Description

1 This button closes the window, and terminates the program

2 This button Restore down or Maximize the window

3 This button Minimize the window

4 A list of all the accounts' names in the database will appear here, the user will be able to choose his/her name from this list if he/she already has an account

5 This button transfers the user to the Letters page through his/her account, and closes this page.

6 This button closes this window and opens the start page

Figure.4.2 Login Page Table

Page 22

Page 23: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

3- Register Page

Figure.5.1 Register Page Print Screen

# Description

1 This button closes the window, and terminates the program

2 This button Restore down or Maximize the window

3 This button Minimize the window

4 The user should enter his/her first name here

5 The user should enter his/her last name here

6 This button when pressed, creates an account for the user, transfers the user to the Letters page through the created account, and closes this page.

7 This button closes this window and opens the start page

Figure.5.2 Register Page Table

Page 23

Page 24: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Figure.5.3 Register Page with Error Message(1) Print Screen

# Description

1 This error message appears if the user entered invalid characters

Figure.5.4 Register Page with Error Message(1) Table

Page 24

Page 25: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Figure.5.5 Register Page with Error Message(2) Print Screen

# Description

1 This error message appears if the combination of the entered first and last name already exists

Figure.5.6 Register Page with Error Message(2) Table

Page 25

Page 26: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

4- Letters Page

Figure.6.1 Letters Page Print Screen

# Description

1 This button closes the window, and terminates the program

2 This button Restore down or Maximize the window

3 This button Minimize the window

4 The entire list of split letters will be enabled to be chosen by the user, when the user clicks on a letter he/she will be transferred to the letter's main page through this letter.

5 The entire list of join letters will be enabled (only if the user have learned and passed all of the split letters) to be chosen by the user, when the user clicks on a letter he/she will be transferred to the letter's main page through this letter. If the user is not done with learning all of the split letters, this menu will be shown but disabled.

Figure.6.2 Letters Page Table

Page 26

Page 27: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

5- Letter's Main Page

Figure.7.1 Letter's Main Page (Split) Print Screen

Figure.7.2 Letter's Main Page (Join) Print Screen

Page 27

Page 28: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Page 28

Page 29: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

# Description

1 This button closes the window, and terminates the program.

2 This button Restore down or Maximize the window.

3 This button Minimize the window.

4 Label that contains the current letter the user chose.

5 List that contains all the split letters.

6 This button will move the user to the Concept page.

7 This button will move the user to the “place on the doll” game.

8 This button will move the user to the “Letter Pronunciation” lesson.

9 This button will move the user to the “Letter Shape” lesson.

10 This button will move the user to the previous page “Letters Page” and close this page.

Figure.7.3 Letter's Main Page (Split) Table

Page 29

Page 30: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

6- "Letter Shape" Page

Figure.12.1 "Letter Shape" Page Print Screen

# Description

1 This button closes the window, and terminates the program

2 This button Restore down or Maximize the window

3 This button Minimize the window

4 This button will move the user to the previous page “Letters Main Page” and close this window.

Figure.12.2 "Letter Shape" Page Table

Page 30

Page 31: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

TEAM MANAGEMENT

TASKS DISTRIBUTION:

Member Responsibilities Description

o

o User Interface Design Overview

o User Interface Designingo User Function Interfaces:

1, 2, 3, 4

Khawla have written the User Interface Design Overview and the User Function Interfaces (3: 1, 2, 3, 4).

She have designed all of the windows of the user interface.

She also modified what she did after the overview by the other members

o

Overview They have revised the remaining members' work.

Figure.12 Tasks Distribution

REVISION:

Reviewer Name Comment Type Page Section Description

Languae mistakes

Missing content

-Introduction

-System Overview

-Data Design

- Detailed System Design

- Detailed System Design

Page 31

Page 32: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

Figure.13 Overview

Page 32

Page 33: Guide for writing a project proposal - Software Engineering II Web viewPlay sound: this function plays the voice of a teacher at the appropriate time. Play sound: this function plays

Guide for writing a System Design Document

REFERENCES

1. Object Oriented Software Design Description, Texas, 2008, http://www2.dir.state.tx.us/SiteCollectionDocuments/IT%20Leadership/Framework/Framework%20Extensions/SDLC%20object%20design%20instructions.pdf

Page 33