SRSExample-webapp - Srs PDF

Preview

Summary

Srs...

Description

Software Requirements Specification Version 1.0

April 15, 2004 Web Publishing System Joan Teamleader Paul Adams Bobbie Baker Charles Charlie Submitted in partial fulfillment Of the requirements of CS 310 Software Engineering



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

i

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

ii

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.

SRS V 1.0

1

April 15, 2004

1.3. Glossary Term Active Article

Definition 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.

SRS V 1.0

2

April 15, 2004

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. Both sections of the document describe the same software product in its entirety, but are intended for different audiences and thus use different language.

SRS V 1.0

3

April 15, 2004

2.0.

Overall Description

2.1

System Environment

Reader

Author

Online Journal

Article Manager

HS DB

Reviewer 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.

SRS V 1.0

4

April 15, 2004

> 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. 2. 3. 4. 5. 6.

The Reader chooses to search by author name, category, or keyword. The system displays the choices to the Reader. The Reader selects the article desired. The system presents the abstract of the article to the reader. The Reader chooses to download the article. The system provides the requested article.

Xref: Section 3.2.1, Search Article

SRS V 1.0

5

April 15, 2004

Review

Rewrite

Active Article Publish

Submit

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.

SRS V 1.0

6

April 15, 2004

1. 2. 3. 4.

The Author chooses the Email Editor button. The System uses the sendto HTML tag to bring up the user’s email system. The Author fills in the Subject line and attaches the files as directed and emails them. 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. 2. 3. 4.

The Reviewer chooses the Email Editor button. The System uses the sendto HTML tag to bring up the user’s email system. The Reviewer fills in the Subject line and attaches the file as directed and emails it. The System generates and sends an email acknowledgement.

Xref: Section 3.2.2, Communicate

SRS V 1.0

7

April 15, 2004

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. 2. 3. 4.

The Editor selects to Add/Update Author. The system presents a choice of adding or updating. The Editor chooses to add or to update. 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.

SRS V 1.0

8

April 15, 2004

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.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. 2. 3. 4. 5.

The Editor selects to Add/Update Reviewer. The system presents a choice of adding or updating. The Editor chooses to add or to update. The system links to the Historical Society Database. 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

SRS V 1.0

9

April 15, 2004

Brief Description The Editor enters information about an existing article. 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. 2. 3. 4. 5.

The Editor selects to Update Article. The system presents s list of active articles. The system presents the information about the chosen article. The Editor updates and submits the form. 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. 2. 3. 4.

The Editor selects to Receive Article. The system presents a choice of entering a new article or updating an existing article. The Editor chooses to add or to update. 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

SRS V 1.0

10

April 15, 2004

Use case: Assign Reviewer This use case extends ...