Introduction to Software Engineering Lab Manual SSUET/QR/114
Lab # 08
Software Requirement Specification (Case Study)
Software Requirements Specification
Version 1.0
<<Annotated Version>>
April 15, 2004
Web Publishing System
Joan Team leader
Paul Adams
Bobbie Baker
Charles Charlie
Submitted in partial fulfillment
Of the requirements of
CS 310 Software Engineering
SWE-104 Introduction to Software Engineering 57
Introduction to Software Engineering Lab Manual SSUET/QR/114
<<Any comments inside double brackets such as these are not part of this SRS but are
comments upon this SRS example to help the reader understand the point being made.
Refer to the SRS Template for details on the purpose and rules for each section of this
document.
This work is based upon the submissions of the Spring 2004 CS 310. The students who
submitted these team projects were Thomas Clay, Dustin Denney, Erjon Dervishaj,
Tiffanie Dew, Blake Guice, Jonathan Medders, Marla Medders, Tammie Odom, Amro
Shorbatli, Joseph Smith, Jay Snellen, Chase Tinney, and Stefanie Watts. >>
SWE-104 Introduction to Software Engineering 58
Table of Contents
Table of Contents...................................................................................................................................i
List of Figures.........................................................................................................................................ii
1.0. Introduction.....................................................................................................................................1
1.1. Purpose..................................................................................................................................................1
1.2. Scope of Project.....................................................................................................................................1
1.3. Glossary.................................................................................................................................................2
1.4. References.............................................................................................................................................2
1.5. Overview of Document.........................................................................................................................2
2.0. Overall Description..............................................................................................................4
2.1 System Environment........................................................................................................................4
2.2 Functional Requirements Specification............................................................................................5
2.2.1 Reader Use Case.......................................................................................................................5
Use case: Search Article......................................................................................................................5
2.2.2 Author Use Case.......................................................................................................................6
Use case: Submit Article......................................................................................................................6
2.2.3 Reviewer Use Case...................................................................................................................7
Use case: Submit Review....................................................................................................................7
2.2.4 Editor Use Cases.......................................................................................................................8
Use case: Update Author.....................................................................................................................8
Use case: Update Reviewer.................................................................................................................9
Use case: Update Article.....................................................................................................................9
Use case: Receive Article..................................................................................................................10
Use case: Assign Reviewer...............................................................................................................11
Use case: Receive Review.................................................................................................................11
Use case: Check Status......................................................................................................................12
Use case: Send Response...................................................................................................................12
Use case: Send Copyright..................................................................................................................13
Use case: Remove Article.................................................................................................................14
Use case: Publish Article...................................................................................................................14
2.3 User Characteristics........................................................................................................................15
2.4 Non-Functional Requirements........................................................................................................15
3.0. Requirements Specification..........................................................................................17
3.1 External Interface Requirements....................................................................................................17
3.2 Functional Requirements................................................................................................................17
3.2.1 Search Article.........................................................................................................................17
3.2.2 Communicate..........................................................................................................................18
3.2.3 Add Author.............................................................................................................................18
3.2.4 Add Reviewer.........................................................................................................................19
3.2.5 Update Person.........................................................................................................................19
3.2.6 Update Article Status..............................................................................................................20
3.2.7 Enter Communication.............................................................................................................20
3.2.8 Assign Reviewer.....................................................................................................................21
3.2.9 Check Status...........................................................................................................................21
3.2.10 Send Communication.............................................................................................................22
3.2.11 Publish Article........................................................................................................................22
3.2.12 Remove Article.......................................................................................................................23
3.3 Detailed Non-Functional Requirements.........................................................................................23
3.3.1 Logical Structure of the Data.................................................................................................23
3.3.2 Security...................................................................................................................................25
Index...............................................................................................................................................................26
SWE-104 Introduction to Software Engineering Page 93
SWE-104 Introduction to Software Engineering Page 94
List of Figures
Figure 1 - System Environment........................................................................................................................4
Figure 2 - Article Submission Process.............................................................................................................6
Figure 3 - Editor Use Cases..............................................................................................................................8
Figure 4 - Logical Structure of the Article Manager Data.............................................................................23
SWE-104 Introduction to Software Engineering Page 95
1.0. Introduction
1.1. Purpose
The purpose of this document is to present a detailed description of the Web Publishing
System. It will explain the purpose and features of the system, the interfaces of the system, what
the system will do, the constraints under which it must operate and how the system will react to
external stimuli. This document is intended for both the stakeholders and the developers of the
system and will be proposed to the Regional Historical Society for its approval.
1.2. Scope of Project
This software system will be a Web Publishing System for a local editor of a regional
historical society. This system will be designed to maximize the editor’s productivity by
providing tools to assist in automating the article review and publishing process, which would
otherwise have to be performed manually. By maximizing the editor’s work efficiency and
production the system will meet the editor’s needs while remaining easy to understand and use.
More specifically, this system is designed to allow an editor to manage and communicate
with a group of reviewers and authors to publish articles to a public website. The software will
facilitate communication between authors, reviewers, and the editor via E-Mail. Preformatted
reply forms are used in every stage of the articles’ progress through the system to provide a
uniform review process; the location of these forms is configurable via the application’s
maintenance options. The system also contains a relational database containing a list of Authors,
Reviewers, and Articles.
1.3. Glossary
Term Definition
SWE-104 Introduction to Software Engineering Page 96
Active Article The document that is tracked by the system; it is a narrative
that is planned to be posted to the public website.
Author Person submitting an article to be reviewed. In case of
multiple authors, this term refers to the principal author,
with whom all communication is made.
Database Collection of all the information monitored by this system.
Editor Person who receives articles, sends articles for review, and
makes final judgments for publications.
Field A cell within a form.
Historical Society Database The existing membership database (also HS database).
Member A member of the Historical Society listed in the HS
database.
Reader Anyone visiting the site to read articles.
Review A written recommendation about the appropriateness of an
article for publication; may include suggestions for
improvement.
Reviewer A person that examines an article and has the ability to
recommend approval of the article for publication or to
request that changes be made in the article.
Software Requirements A document that completely describes all of the functions
Specification of a proposed system and the constraints under which it
must operate. For example, this document.
Stakeholder Any person with an interest in the project who is not a
developer.
User Reviewer or Author.
1.4. References
IEEE. IEEE Std 830-1998 IEEE Recommended Practice for Software Requirements
Specifications. IEEE Computer Society, 1998.
1.5. Overview of Document
The next chapter, the Overall Description section, of this document gives an overview of
the functionality of the product. It describes the informal requirements and is used to establish a
context for the technical requirements specification in the next chapter.
The third chapter, Requirements Specification section, of this document is written
primarily for the developers and describes in technical terms the details of the functionality of
the product.
SWE-104 Introduction to Software Engineering Page 97
Both sections of the document describe the same software product in its entirety, but are
intended for different audiences and thus use different language.
SWE-104 Introduction to Software Engineering Page 98
2.0. Overall Description
2.1 System Environment
Reader
Author Online Journal
Article Manager
Reviewer HS DB
Web Publishing System
Editor
Figure 1 - System Environment
The Web Publishing System has four active actors and one cooperating system.
The Author, Reader, or Reviewer accesses the Online Journal through the Internet. Any Author
or Reviewer communication with the system is through email. The Editor accesses the entire
system directly. There is a link to the (existing) Historical Society.
SWE-104 Introduction to Software Engineering Page 99
<< The division of the Web Publishing System into two component parts, the Online Journal and
the Article Manager, is an example of using domain classes to make an explanation clearer. >>
2.2 Functional Requirements Specification
This section outlines the use cases for each of the active readers separately. The reader,
the author and the reviewer have only one use case apiece while the editor is main actor in this
system.
2.2.1 Reader Use Case
Use case: Search Article
Diagram:
Search Article
Reader
Brief Description
The Reader accesses the Online Journal Website, searches for an article and downloads it to
his/her machine.
Initial Step-By-Step Description
Before this use case can be initiated, the Reader has already accessed the Online Journal
Website.
1. The Reader chooses to search by author name, category, or keyword.
2. The system displays the choices to the Reader.
3. The Reader selects the article desired.
4. The system presents the abstract of the article to the reader.
5. The Reader chooses to download the article.
6. The system provides the requested article.
Xref: Section 3.2.1, Search Article
SWE-104 Introduction to Software Engineering Page 100
Review
Rewrite
Active Article
Submit Publish
Figure 2 - Article Submission Process
The Article Submission Process state-transition diagram summarizes the use cases listed below.
An Author submits an article for consideration. The Editor enters it into the system and assigns it
to and sends it to at least three reviewers. The Reviewers return their comments, which are used
by the Editor to make a decision on the article. Either the article is accepted as written, declined,
or the Author is asked to make some changes based on the reviews. If it is accepted, possibly
after a revision , the Editor sends a copyright form to the Author. When that form is returned, the
article is published to the Online Journal. Not shown in the above is the removal of a declined
article from the system.
2.2.2 Author Use Case
In case of multiple authors, this term refers to the principal author, with whom all
communication is made.
Use case: Submit Article
Diagram:
Submit Article
Author
Brief Description
The author either submits an original article or resubmits an edited article.
Initial Step-By-Step Description
Before this use case can be initiated, the Author has already connected to the Online Journal
Website.
1. The Author chooses the Email Editor button.
SWE-104 Introduction to Software Engineering Page 101
2. The System uses the sendto HTML tag to bring up the user’s email system.
3. The Author fills in the Subject line and attaches the files as directed and emails them.
4. The System generates and sends an email acknowledgement.
Xref: Section 3.2.2, Communicate
2.2.3 Reviewer Use Case
Use case: Submit Review
Diagram:
Submit Review
Reviewer
Brief Description
The reviewer submits a review of an article.
Initial Step-By-Step Description
Before this use case can be initiated, the Reviewer has already connected to the Online Journal
Website.
1. The Reviewer chooses the Email Editor button.
2. The System uses the sendto HTML tag to bring up the user’s email system.
3. The Reviewer fills in the Subject line and attaches the file as directed and emails it.
4. The System generates and sends an email acknowledgement.
Xref: Section 3.2.2, Communicate
SWE-104 Introduction to Software Engineering Page 102
2.2.4 Editor Use Cases
The Editor has the following sets of use cases:
Update Info
Handle Art
Ck Status
Editor
Send Rec
Publish Art
Figure 3 - Editor Use Cases
Update Information use cases
Use case: Update Author
Diagram:
Update Author
Editor
Brief Description
The Editor enters a new Author or updates information about a current Author.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the main page of the Article
Manager.
1. The Editor selects to Add/Update Author.
2. The system presents a choice of adding or updating.
3. The Editor chooses to add or to update.
4. If the Editor is updating an Author, the system presents a list of authors to choose from and
presents a grid filling in with the information; else the system presents a blank grid.
5. The Editor fills in the information and submits the form.
SWE-104 Introduction to Software Engineering Page 103
6. The system verifies the information and returns the Editor to the Article Manager main page.
Xref: Section 3.2.3, Add Author; Section 3.2.5 Update Person
Use case: Update Reviewer
Diagram:
Update Reviewer
Hist Soc DB
Editor
Brief Description
The Editor enters a new Reviewer or updates information about a current Reviewer.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the main page of the Article
Manager.
1. The Editor selects to Add/Update Reviewer.
2. The system presents a choice of adding or updating.
3. The Editor chooses to add or to update.
4. The system links to the Historical Society Database.
5. If the Editor is updating a Reviewer, the system and presents a grid with the information
about the Reviewer; else the system presents list of members for the editor to select a
Reviewer and presents a grid for the person selected.
6. The Editor fills in the information and submits the form.
7. The system verifies the information and returns the Editor to the Article Manager main
page.
Xref: Section 3.2.4, Add Reviewer; Section 3.2.5, Update Person
Use case: Update Article
Diagram:
Update Article
Editor
Brief Description
The Editor enters information about an existing article.
SWE-104 Introduction to Software Engineering Page 104
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the main page of the Article
Manager.
1. The Editor selects to Update Article.
2. The system presents s list of active articles.
3. The system presents the information about the chosen article.
4. The Editor updates and submits the form.
5. The system verifies the information and returns the Editor to the Article Manager main page.
Xref:Section 3.2.6, Update Article Status
Handle Article use cases
Use case: Receive Article
Diagram:
Receive Article
Editor
Brief Description
The Editor enters a new or revised article into the system.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the main page of the Article
Manager and has a file containing the article available.
1. The Editor selects to Receive Article.
2. The system presents a choice of entering a new article or updating an existing article.
3. The Editor chooses to add or to update.
4. If the Editor is updating an article, the system presents a list of articles to choose from and
presents a grid for filling with the information; else the system presents a blank grid.
5. The Editor fills in the information and submits the form.
6. The system verifies the information and returns the Editor to the Article Manager main page.
Xref: Section 3.2.7, Enter Communication
Use case: Assign Reviewer
This use case extends the Update Article use case.
Diagram:
SWE-104 Introduction to Software Engineering Page 105
Assign Reviewer
Hist Soc DB
Editor
Brief Description
The Editor assigns one or more reviewers to an article.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to Assign Reviewer.
2. The system presents a list of Reviewers with their status (see data description is section 3.3
below).
3. The Editor selects a Reviewer.
4. The system verifies that the person is still an active member using the Historical Society
Database.
5. The Editor repeats steps 3 and 4 until sufficient reviewers are assigned.
6. The system emails the Reviewers, attaching the article and requesting that they do the review.
7. The system returns the Editor to the Update Article use case.
Xref: Section 3.2.8, Assign Reviewer
Use case: Receive Review
This use case extends the Update Article use case.
Diagram:
Receive Review
Editor
Brief Description
The Editor enters a review into the system.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to Receive Review.
SWE-104 Introduction to Software Engineering Page 106
2. The system presents a grid for filling with the information.
3. The Editor fills in the information and submits the form.
4. The system verifies the information and returns the Editor to the Article Manager main page.
Xref: Section 3.2.7, Enter Communication
Check Status use case:
Use case: Check Status
Diagram:
Check Status
Editor
Brief Description
The Editor checks the status of all active articles.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the main page of the Article
Manager.
1. The Editor selects to Check Status.
2. The system returns a scrollable list of all active articles with their status (see data description in
section 3.3 below).
3. The system returns the Editor to the Article Manager main page.
Xref:Section 3.2.9, Check Status
Send Recommendation use cases:
Use case: Send Response
This use case extends the Update Article use case.
SWE-104 Introduction to Software Engineering Page 107
Diagram:
Send Response
Editor
Brief Description
The Editor sends a response to an Author.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to Send Response.
2. The system calls the email system and puts the Author’s email address in the Recipient line and
the name of the article on the subject line.
3. The Editor fills out the email text and sends the message.
4. The system returns the Editor to the Article Manager main page.
Xref:Section 3.210, Send Communication
Use case: Send Copyright
This use case extends the Update Article use case.
Diagram:
Send Copyright
Editor
Brief Description
The Editor sends a copyright form to an Author.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to Send Copyright.
2. The system calls the email system and puts the Author’s email address in the Recipient line, the
name of the article on the subject line, and attaches the copyright form.
3. The Editor fills out the email text and sends the message.
4. The system returns the Editor to the Article Manager main page.
SWE-104 Introduction to Software Engineering Page 108
Xref: Section 3.2.10, Send Communication
Use case: Remove Article
This use case extends the Update Article use case.
Diagram:
Remove Article
Editor
Brief Description
The Editor removes an article from the active category.
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to remove an article from the active database.
2. The system provides a list of articles with the status of each.
3. The Editor selects an article for removal.
4. The system removes the article from the active article database and returns the Editor to the
Article Manager main page.
Xref: Section 3.2.12, Remove Article
Publish Article use case:
Use case: Publish Article
This use case extends the Update Article use case.
Diagram:
Publish Article
Editor
Brief Description
The Editor transfers an accepted article to the Online Journal.
SWE-104 Introduction to Software Engineering Page 109
Initial Step-By-Step Description
Before this use case can be initiated, the Editor has already accessed the article using the Update
Article use case.
1. The Editor selects to Publish Article.
2. The system transfers the article to the Online Journal and updates the search information there.
3. The system removes the article from the active article database and returns the Editor to the
Article Manager home page.
Xref:Section 3.2.11, Publish Article
<< Since three of the actors only have one use case each, the summary diagram only involves the
Editor. Adapt the rules to the needs of the document rather than adapt the document to fit the
rules. >>
2.3 User Characteristics
The Reader is expected to be Internet literate and be able to use a search engine. The
main screen of the Online Journal Website will have the search function and a link to
“Author/Reviewer Information.”
The Author and Reviewer are expected to be Internet literate and to be able to use email
with attachments.
The Editor is expected to be Windows literate and to be able to use button, pull-down
menus, and similar tools.
The detailed look of these pages is discussed in section 3.2 below.
2.4 Non-Functional Requirements
The Online Journal will be on a server with high speed Internet capability. The physical
machine to be used will be determined by the Historical Society. The software developed here
assumes the use of a tool such as Tomcat for connection between the Web pages and the
SWE-104 Introduction to Software Engineering Page 110
database. The speed of the Reader’s connection will depend on the hardware used rather than
characteristics of this system.
The Article Manager will run on the editor’s PC and will contain an Access database.
Access is already installed on this computer and is a Windows operating system.
SWE-104 Introduction to Software Engineering Page 111
3.0. Requirements Specification
3.1 External Interface Requirements
The only link to an external system is the link to the Historical Society (HS) Database to
verify the membership of a Reviewer. The Editor believes that a society member is much more
likely to be an effective reviewer and has imposed a membership requirement for a Reviewer.
The HS Database fields of interest to the Web Publishing Systems are member’s name,
membership (ID) number, and email address (an optional field for the HS Database).
The Assign Reviewer use case sends the Reviewer ID to the HS Database and a Boolean
is returned denoting membership status. The Update Reviewer use case requests a list of member
names, membership numbers and (optional) email addresses when adding a new Reviewer. It
returns a Boolean for membership status when updating a Reviewer.
3.2 Functional Requirements
The Logical Structure of the Data is contained in Section 3.3.1.
3.2.1 Search Article
Use Case Name Search Article
XRef Section 2.2.1, Search Article
SDD, Section 7.1
Trigger The Reader assesses the Online Journal Website
Precondition The Web is displayed with grids for searching
Basic Path 1. The Reader chooses how to search the Web site. The choices
are by Author, by Category, and by Keyword.
2. If the search is by Author, the system creates and presents an
alphabetical list of all authors in the database. In the case of
an article with multiple authors, each is contained in the list.
3. The Reader selects an author.
4. The system creates and presents a list of all articles by that
author in the database.
5. The Reader selects an article.
6. The system displays the Abstract for the article.
7. The Reader selects to download the article or to return to the
article list or to the previous list.
SWE-104 Introduction to Software Engineering Page 112
