Design Document Format

8/13/2019 Design Document Format

1/25

Software DesignDocument(SDD)

For

SOCIAL NETWORKING

Version:(1.0) Date:

Department of Computer Science Engineering

Vyas Institute of Engineering and Technology

Session 2013-14


2/25

[Project name]

[Page no]

APPROVAL and Compulsory Review LIST

Role Name Date

Projetc Guide Mr. Dinesh Khichi

Version TrackingDate Version Comments Author


3/25

Table of Contents

1.0 Introduction ........................................................................................................ 2

2.0 Functional Description ...................................................................................... 3

3.0 Functional Partitions ......................................................................................... 7

3.1Module Name .............................................................................................................................. 7

3.1.1 Home ....................................................................................................................................... 7

4.0 Data Description ............................................................................................... 12

4.1 Data Flow Diagram / UML Diagram ................................................................................. 12

4.2 Flow Chart .......................................................................................................................... 14

4.3 Database Description .......................................................................................................... 16

5.0 User Interface Design ....................................................................................... 17

5.1 HOME PAGE ..................................................................................................................... 17

6.0 Module Description .......................................................................................... 18

6.1 Module Name ..................................................................................................................... 18

Requirement Analysis. ........................................................................................................... 18

Documentation and Planning. ................................................................................................ 18

7.0 Definitions and Acronyms ............................................................................... 21

8.0 References ......................................................................................................... 23


4/25

[Project name]

2

1.0 IntroductionThis is the age of contacts for interaction between people to people through social platforms in the

web. The tremendous popularity of using the social media networking could never have been

realized before. The scope of social networking is widening, and today it offers a strong support to

the companies in providing the much desired touch of concern.

This is the beginning of interweaving social media networking as a positive business process

bringing two people together than merely two organizational entities. People can communicate their

message to the suppliers or customers and also convey any difference of opinion over the social

networks. The business community has started to take a keen interest in the enormous possibilities

of reaching and serving the buyers in this emerging domain of marketing.

Social media networking is may be for improving the products listening to the customers views

with critical appreciations. It may also help improving the ways of dealing with buyer of the

organization. All the big companies are quite optimistic about the positive impact of Social media

networking and gone into developing fully integrated processed with a holistic touch. Take the

example of the companies like IBM, Microsoft and Google performs to strengthen their networking

platforms via social networks like Twitter and Facebook.

The bright future prospect of social networking is also proven with the fact that the technology isintegrated in the mobile phones as well. Look at the devices designed with powers of interpersonal

communication on a globalized outlook. These devices are now being created to with the

perspective of global interaction and messaging across geographical boundaries. The concept is one,wherever on the earth; reach the common platform of the people for everybodys benefit.


5/25

[Project name]

3

2.0 Functional DescriptionThe system should provide an interactive home page which must include the following details:

Login ID :it should serve the functionality of providing the facility to create a login ID. The ID ofthe person will determine that whether the person has a particular email id or not.

Userlogin:

I nput : Email id and password are provided as input.

Output:(ii) I f the email id and password entered are correct then user will be able to see and use

following details :

Post :it wil provide the posts what other members of this website are thinking upto or what is

going around them.

Share: this feature will allow the user to share the photos or any of the posts on his/her wall.

Send Messages: it will include the conversations and in this section we can send messages toother members of the networking website.

Profile Update: this will include updation of the profile of the user itself. This will includename of the user,working of user,date of birth etc.

Request Accept/Reject: This can accept or reject any friend request arrived to the user.

Find Friends: This section can find any of our friends according to the name and placeprovided. This would give the number of suggestions of the other users as per the details

provided.

Settings: This section include privacy settings and account settings. In account settings we

can change


6/25

[Project name]

4

Friend: This section show all the friend of user with their name and other details shown.

Constraints: On the basis of above input if the email id and password are incorrect then it will

reload the same page and will reset the above information entered. And it wont be able to login..

After creating a login id teacher must be able to get following details:-

Post

Share

Send Message

Profile Update

Request Accept/Reject

Find Friends

Settings

Friend

Constraints: If the details provided at the time of login are found to be fake then the persontrying to login must not be able to login for next 2 hours.


7/25

[Project name]

5

Functional Block Diagram Of Project To Be Developed:-

SettingsFind

FriendsFriendsProfile Message

INDEX

Log-in(For Registered User)

Register(For New User)

Access Site Content

Home Logout


8/25

[Project name]

6

Brief description of each block explained/shown in the softwaresblock diagram:-

Index: This is the main page of the website so developed displaying the content tabsand the loginpanel. The users cant access the site content without registering

themselves at the site.

Log-in:The user needs to be logged-in, in order to access the site content. Only afterthe provided/entered login data being correct or valid, the user would be redirected to

the home-page & thus after, can access the site content.

Register:If the user is new to the site, he/she needs to register themselves to the siteby providing their valid email id and also the desired password for the site of success.

Access Site Content:After being registered at the site or after logging in to the site,

the user can access the site contents or is thus authorized to surf the whole site ashis/her home.

Home:This portion of the site contains the post or shares by other members of the

user in random manner.

Profile:This portion of the site contains the profile of the user which is logged in. Andin this block the user can update his/her profile.

Messages:This portion of the site contains the converstions done so far. The message

history can be deleted. And with the help of this block we can even send messgaes toother members.

Friends :This portion of the site contains the list of all friends added in the users

account.

Find Friends:This portion of the website contains the search option for findingfriends according to the details provided by the user.

Settings:This section consists of the privacy settings and account settings.


9/25

[Project name]

7

3.0 Functional Partitions3.1Module Name:

3.1.1Home

Home Screen consists of a login panel and tabs naming:

1. Profile

2. Message

3. Find Friends

4. Friends

5. Setting

6. Notification

Tabs inaccessible for unregistered user.

3.1.2 Login

This Phase occurs after the user gets logged-in to the site through entering genuine

Login info. After logging-in, the homepage gets updated and in place of the lagin panel, that

area start showing the site notification of the database being updated. Also it contains thefollowing six tabs naming:

1. Previous Year Papers

2. Sample Papers

3. Syllabus

4. Software

5. Contact Us

6. Forum

Tabs are now accessible as the user is logged in (is Registered User).

3.1.3 Syllabus

This module contains the information regarding the syllabus arranged each in a proper

manner as :

BRANCH ===> SEMESTER ===> SUBJECT


10/25

[Project name]

8

3.1.4Papers

This module contains the information regarding the question papers, both, Previous Year

Papers and the Sample Papers arranged each in a proper manner as :


3.1.3 Softwares

This module contains the important softwares that the users (student / teacher or even anydeveloper) would require. For eg. Turbo C++, Java, Visual Basic, Visual C++< Visual

Studio, etc.

3.1.3 Book Referrance

This module contains the information regarding the books that are being preferred by thespecialists or the professional and experienced teachers arranged each in a proper manner as :


3.1.3 Forum

This module contains the forum data. A forum consists of the queries asked by the users and

the comments(solution) provided by the other users on that being helpful in solving thequery.

3.1.3 Contact Us

This module contains the information containing the ways for people/users to interact with

the site developers and the rights to b followed by everyone wishing to have help. It contains

the developers(admin) email id through which users/guests could be able to contact forgetting his\her query(request) being resolved.


11/25

[Project name]

9

3.1.1 Functional Block Diagram of modules discussed above :-

HOME AND LOG-IN :-

Accessible only if

Registerd user is Logged-in

MESSAGES:-

HOME

Messages Settings Friends Find Friends Post/Share

MESSAGES

FRIEND

SEND MSG

DELETE


12/25

[Project name]

10

SETTINGS:-

SOFTWARE :-

SOFTWARE

PAPERS

Branch

Semester

Subject

VIEW DOWNLOAD


13/25

[Project name]

11

FORUM :-

CPNTACT US :-

FORUM

POST COMMENT

Contact Us

View Rights &

Policy

Email the

Developer/Admin


14/25

[Project name]

12

4.0 Data Description4.1Data Flow Diagram / UML DIAGRAMS

NOTIFICATION

.RegisterLog-in

UPDATE

Posts (in forum)DATABASE

Comments (in forum)GRANTING PERMISSION

BLOCKING ACTIONS

(LEVEL 0) DFD

STUDENT

STUDY STUFF

SYSTEM

USERADMIN


15/25

[Project name]

13

CONTROL ACCESS

PERMISSIONS

NOTIFICATION

FORM

DATABASE

REGISTRATION SUCCESSFULL

CHECK VERIFIED

REGISTRATION FAIL

ID SAVING

PASSWORD

ID CHECKPASSWORD

NOTIFICATION

POST/COMMENT (in forum) UPDATE DATABASE

ONLY FOR REGISTEREDUSER (LOGGED IN) CONTROL POSTS

SITE

DATABASE

(LEVEL 1) DFD

REGIST

R--ATION

PROCESS

USERLOGIN

PROCESS

VALIDATION

SITE

CONTENT

ACCESS

ADMIN


16/25

[Project name]

14

4.2Flow Chart:-

NO

NO

YES YES

HOME

START

Login Register/Join

Access Site Content

DownloadView

Logout

Username&Password

Login Id& Password

(desired)

If

GenuineUser

Validate

&

Verify

STOP


17/25

[Project name]

15

E-R Diagram

ADMIN

UpdatesControl

Contents

of

Site ContentsFORUM

Date

Posts

Time

Name

Comments

Grants

Permission

toSyllabus Softwares Papers

Year Subject

Branch

Ver. Size

Name

Subject

Branch

Year

USER

Access

By

PostsIn

Id

Na

Occupation

Pwd

Designation

IdPwd


18/25

[Project name]

16

4.3 Database Description4.3.1 Table Name: loginField Name Data Type Synonyms Description

Username VarChar ---

This data field

stores the username

of registered

member.

Password VarChar,Int ---

This data field

stores the usernameof registered

member.

Designation VarChar ---

This data field

stores thedesignation of user

i.e. either the user is

student or teacher.


19/25

[Project name]

17

5.0 User Interface Design5.1HOME PAGE:

Not a Member Yet?

HOME

User ID :

Password:

Remember Me

Syllabus

Papers

Softwares

Book

References

Forum

Contact Us


20/25

[Project name]

18

6.0 Module Description6.1Module Name:

Requirement Analysis:As per the needs of the B.tech studentsprevious year papers, samplepapers, book references are the main

aspects which occur in front. The Above listed Requirements arefulfilled by our website.

Documentation and Planning: After Analyzing the requirements ofuserS.R.S.(Software Requirement Specification) and S.D.D.(Software Design

Document) were prepared.

Designing: After completing the all the documentations, the Designing regarding

the website was developed.

6.1.1.1.1 Function Name: Log-inThis Function is called when thevisitor of site tries to log in to the site. The functions

accepts the username and password from the user, and checks into the database if it is matched withthe values of database, it gives user access to the site.

6.1.1.1.1.1 Declarationfunctionlog_in($usr_name,pwd )

{

Body Of function

}


21/25

[Project name]

19

6.1.1.1.1.2ParametersParameter Type Parameter Name Parameter Description

VarChar usr_name Contains the name of user.

Varchar,int pwd Contains password of registered user.

6.1.1.1.1.3Return valuesThe function returns Boolean values TRUE or FALSE.

6.1.1.1.1.4Pseudo code1. The Functions Accepts the user name and password of the guest.2. The accepted username and password received are checked with the values in database.

3. If the values of the entered data matches the values in database, it returns the Boolean value

TRUE otherwise FALSE

6.1.1.1.2 Function Name: Register UserThis Function is called when the visitor of site tries to become member of the site.

The functions accepts the desired values like name, username, password and designation from the

user, and adds values into the database record.

6.1.1.1.2.1 Declarationfunctionreg_usr($usr_name,pwd,dsgntn,name )

{

Body Of function

}


22/25

[Project name]

20

6.1.1.1.2.2ParametersParameter Type Parameter Name Parameter DescriptionVarChar name Contains Name of the User.

VarChar dsgntn Contains the designation of the user either student or

teacher.

VarChar usr_name Contains the name of user.

VarChar occupation Contains occupation of the user.

Varchar,int pwd Contains password of registered user.

6.1.1.1.2.3Return valuesThe function doesnot returns any value.

6.1.1.1.2.4Pseudo code1. The Functions Accepts the name, user name, password and designation of the guest.

2. The values received are then added into the database.


23/25

[Project name]

21

7.0 Definitions and AcronymsAbbreviation Description


24/25

[Project name]

22


25/25

[Project name]

23

8.0 ReferencesIn this section list out all the references used for developing this document and the software.

Design Document Format

Documents

Transcript of Design Document Format