Software Architecture Document Template

17
Tierracon Homes VI Version: 5.0 Software Architecture Document Date: 08-05-14 Tierracon Homes VI Software Architecture Document Version 5.0 Confidential Wiggle, 2014 Page 1 of 17

description

Software architecture document

Transcript of Software Architecture Document Template

Page 1: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

Tierracon Homes VISoftware Architecture Document

Version 5.0

Confidential Wiggle, 2014 Page 1 of 13

Page 2: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

Document history

Date Version Description Author07/29/14 1.0 First Draft of the SAD Carloto, Charles

Gevanne U.07/30/14 2.0 Revision of Document Panelo, Regie Nald C.08/01/14 3.0 Adding Additional Information Carloto, Charles

Gevanne U.08/02/14 4.0 Revision of Document Mariano, John Edward

L.08/05/14 5.0 Adding Information the Document Carloto, Charles

Gevanne U.

DistributionName 1.0 2.0 3.0 4.0 5.0Carloto, Charles Gevanne U.Mariano, John Edward L.Panelo, Regie Nald

Document approval

Wiggle

Carloto, Charles Gevanne U.

Mariano, John Edward L.

Panelo, Regie Nald C.

Tierracon Homes VI

………………….

Confidential Wiggle, 2014 Page 2 of 13

Page 3: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

Contents

1. Introduction

1.1 Purpose of this document1.2 References1.3 Document Overview

2. Architectural requirements

2.1 Non-functional requirements2.2 Use Case View (functional requirements)

3. Logical View

3.1 Tiers3.2 Subsystems3.3 Use Case Realizations

4. Implementation View

4.1 Structure of the packages

5. Deployment View

Confidential Wiggle, 2014 Page 3 of 13

Page 4: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

1. Introduction

1.1 Purpose of this document

This Software Architecture Document provides a comprehensive overview of the Website for Tierracon VI system. By using different architectural views to illustrate different aspects of the system. In order to capture and convey the significant architectural decision which has been made on the system.

The description makes use of the well-known 4+1 view model.

The 4+1 model describing the architecture of the system, based on the multiple concurrent views. The views are used to describe the system from a viewpoint of different stakeholders, such a s end-users, developers and project managers. The four views of the model are logical, development, process and physical view. The views can be seen in the latter part of documents.

Confidential Wiggle, 2014 Page 4 of 13

Page 5: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

1.2 References

Title Version Author Location

caArray Development KokotovD https://wiki.nci.nih.gov/display/caArray2project/Software+Architecture+Document

Car Pooling: “Share My Ride” Elif Selin Alkan,

Cansu Helvacioglu,

Gokhan Babacan

Distributed Team Collaboration Process II Tool (DTC PII Tool)

1.4 Ivan Dontsov,Andy Phenix,

Maureen Rottschaefer

Online Catering Servicer 1.0 Yummy Inc.Architecture team

1.3 Document Overview

Chapter Reader Objective

2 Architectural Software Architect Overview of architecturally relevant requirements.

3 Logical View Developer Knowledge of the application’s conceptual structure, as a basis for technical designs.

4 Implementation View

Developer Knowledge of the application’s technical structure.

5 Deployment View

System Administrator roles Knowledge of the way in which the application is deployed and (internal and external) communication takes place.

Confidential Wiggle, 2014 Page 5 of 13

Page 6: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

2. Architectural requirements

This section describes the different kinds of requirements that enable the developers of this Software Architecture Document to attain the aimed output of the proposed system. This chapter will briefly determine and explain the functional and non-functional requirements of the system.

2.1 Non-functional requirements

This part of the document summarizes those requirements that address aspects of the system besides the functionalities and that are relevant for the system architecture. The non-functional requirements of the Website for Tierracon Homes VI has constraints and qualities.

Constraints - it is the limitations and conditions on the system.

● The website needs to run to any web browser.● The website needs internet connection to be opened.

Qualities - it is the qualities of the website in terms of service and management.

● The websites user accounts security has encryption of password to improve security.● The website has an audit that can record every transaction of done by the users.● The website should give a precise result if the user search for something or someone.● The website can backup databases and recover them if something has happen to the

existing database.● The website is done through a lot of data gathering and complicated research about

the design and process in the website.

Confidential Wiggle, 2014 Page 6 of 13

Page 7: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

2.2 Use Case View (functional requirements)

Confidential Wiggle, 2014 Page 7 of 13

Page 8: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

Primary Actors:● Guest/Homeowner

○ The one that can login to the website.○ Can view the event/news, billing, homeowner of the month, advertisement, location

and officers○ Has the capability to edit their own account○ Can vote during officers election

● Admin

○ Can do what the Guest/Homeowner capable of doin.○ Can manage the account in terms of creating, reading, updating and deleting.○ Can manage news and events in terms of creating, reading, updating and deleting.○ Can manage advertisement in terms of creating, reading, updating and deleting.○ Can manage homeowner of the month in terms of creating, reading, updating and

deleting.○ Can manage voting poll in terms of creating, reading, updating and deleting.○ Can generate reports such as billing, remittance, monthly dues report and list of

homeowners.

Confidential Wiggle, 2014 Page 8 of 13

Page 9: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

3. Logical View

3.1 Tiers

The website for Tierracon is divided into layers based on the N-tier architecture. The layering model of the website is based on responsibility layering strategy that associates each layer with a particular task. This strategy has been chosen due to it divide different system responsibilities from one another, so that it improves both system development and maintenance.

● The Client Tier is the one that the users can see.● The Web Tier deals with the pages rendering and presentation logic.● The Business Tier deals with the main functionalities of the system such as posting,

management of accounts and other system function.● The EIS Tier deals with the storing, retrieving, deleting and updating the data of the

system.

3.2 Subsystems

The website for Tierracon Homes VI has different subsystem. This subsystems are:

● Registration

○ This is the initial part of enabling the function of a homeowner, but before you can register you need to be a residence in the Tierracon Homes VI.

● Viewing

○ This is modules can be used by all users so they can see the event/news, advertisement, homeowner of the month, advertisement, location and officers. Different views has different queries or filter that can show what the user wants to view.

● Voting

○ This module can be used by the user who has account that can help them to vote wherever the user is.

Confidential Wiggle, 2014 Page 9 of 13

Page 10: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

● Profile Editing

○ This module can be used by the user who has account that can enable them to change their information.

● Managing Account

○ This module can only be used by the website admin that can enables to create, read, update or delete accounts.

● Managing Event/News

○ This module can only be used by the website admin that can enables to create, read, update or delete event/news.

● Managing Advertisement

○ This module can only be used by the website admin that can enables to create, read, update or delete advertisement.

● Managing Homeowner of the Month

○ This module can only be used by the website admin that can enables to create, read, update or delete homeowner of the month.

● Managing Monthly Dues

○ This module can only be used by the website admin that can enables to create, read, update or delete monthly dues record.

● Managing Vote Poll

○ This module can only be used by the website admin that can enables to create, read, update or delete vote poll.

● Generating of Report

○ This module can only be used by the website admin that can grant to print reports such as billing, remittance, monthly dues report and list of homeowners.

3.3 Use Case Realizations

❖ The Homeowner Login

The system will check if the account id and password is valid. Then the system will check the access level of the account. So the system can show what functionalities can be used by the user.

❖ The Homeowner checks Event, Transaction Record, Advertisement or Homeowner of the Month

The system will fetch the data from the database or data storage of the system, that can be displayed in the website.

Confidential Wiggle, 2014 Page 10 of 13

Page 11: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

❖ The System Admin CRUD task

● Create Account, Event/News, Advertisement, Homeowner of the Month or Monthly Dues

The system admin will enter the information needed, after the entering the data the system will check if there is any blank or wrong input. If no error were found the system will store the entered data in the database.

● Read/Open Account, Event/News, Advertisement, Homeowner of the Month or Monthly Dues

The system admin will enter the name or id in the textbox. The system will check if the input was valid, if valid then the system will retrieve the information of the matching name or id.

● Update Account, Event/News, Advertisement, Homeowner of the Month or Monthly Dues

The system admin will search an account, event, advertisement, homeowner of the month or monthly dues. If the system admin made any modification to the information. The system will overwrite the previous information with the new one.

● Delete Account, Event/News, Advertisement, Homeowner of the Month or Monthly Dues

The system will delete the selected information.

Confidential Wiggle, 2014 Page 11 of 13

Page 12: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

4. Implementation View

An architectural view is the one that describes the grouping of the static software

elements such as code, data and other software elements. In the development environment in

terms of both layering, packaging and configuration management.

4.1 Structure of the packages

Confidential Wiggle, 2014 Page 12 of 13

Page 13: Software Architecture Document Template

Tierracon Homes VI Version: 5.0Software Architecture Document Date: 08-05-14

5. Deployment View

An architectural view that describes one or several system configurations; the mapping of software components (tasks, modules) to the computing nodes in these configurations.

Confidential Wiggle, 2014 Page 13 of 13