High Level Design

Download as doc, pdf, or txt
Download as doc, pdf, or txt
You are on page 1of 4

RequirementsandHighLevelDesign(HLD)Document

Thisdocumentwillspecifytherequirementsandthehighleveldesignofthedesired
architecture.Thisdocumentwillhelpdecidehowtherequirementswillbemetbythe
proposedarchitectureandsoftware.

Theoutcomeofthisdocumentistoproducethebestandmosteffectiveoveralldesignof
theapplicationtomeettheneedsofthespecifiedrequirements.

1.1Introduction

ThisusercasediagramisanexampleofaBlogingSystem.Itshowsthecomponentsofa
systemusedbetweentheshodorstaff/administratorstothestudents.Throughthisblog
systemtherearecertainspecificationsthatcanbemanipulatedmyeitherthestaffor
students.Thiswillbeusedtoshowassignedblogtasksandcomments.

1.2SubjectMatterExpertsAgreementList

Thissectionshouldlistallkeypeopleinvolvedintheproject.Itwillensurethatall
mandatoryreviewershavereviewedandagreetotherequirementsandproposed
architecture.

Name Title/Role Mandatory AgreedTo


Reviewer
(Y/N)
Kaylynn ProjectLeader Y Createtheuse
casemodel
Jonathan Client Y Give
appropriate
requirements
Paris Programmer Y Writebrief
descriptions
aboutthe
system
Alex Programmer Y Createtheuse
casemodel
Whitley Programmer Y Writebrief
descriptions
aboutthe
system
1.3Requirements

Createaninterfacethatallowsstaffandadministratortoassignblogsto
students
Onlyforshodorpeople
Shodorstaffsaretheonlypeoplewhocancreateblogs
Unlimitedentries
Canonlybedeletedbythestaff
Oneblogperstudent
Shodorpeoplecancommentandread
Studentscanaddentriesonlyifassignedtothem

DefinitionofObjects:

Blog:Journalthatisassignedtostudentsbythestaff
Entry:Attributeofablog,whichisapostinresponsetotheblogtopic
Comment:Adifferentresponsetotheoverallentryandblog

UseCaseDiagram
1.3.2RequirementsTable:

Requirements Description Comments Requirement V&V


Class Method

Login Youmustbea Required


studentonStaff
tousethis
application
Createblog The Required
administrator
(staff)isthe
onlypersonwho
cancreateablog
forthemselves
orstudents
Assignblog The Required
administrator
canassignblogs
tostudentsor
themselvesor
another
administrator.
Onlyoneblog
perstudent
Receiveblog Bothstudents Required
and
administrators
canreceive
blogs
Postentrytomy Onceablogis Required
blog assignedtoa
studentthenthey
canpostand
allowreadersto
viewtheentry
Reviewentry Whenareader Optional
viewsandreads
theblogentry
Commentonentry Onceareader Optional
viewsandreads
theblogthey
canadda
comment
Edit/Delete Administrators Optional
comment caneditor
deleteanother
usersblogentry
orcomments,as
wellastheir
ownblogor
comments
Edit/Deletemy Theownerofan Optional
comment entryor
commentcan
deleteit
Deleteblog The Optional
administrators
candeleteblogs
andentries
Logout Theuserslogged Required
inareabletolog
our

1.4DesiredBehavior

Thisprogramisdesignedtoallowadministratorstocreatereadandeditblogs.The
programalsoallowstheusertogivetheirpersonalcommentsabouttheirblogorablog
theyhaveread.

Note:Allfeasibleoptionsforimplementingthespecifiedcomponentshouldbediscussed.

You might also like