0% found this document useful (0 votes)
193 views

Jatayu - Architecture Document

Uploaded by

deepika shankar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
193 views

Jatayu - Architecture Document

Uploaded by

deepika shankar
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 13

Architecture Document for

<Project Name>

. . . . . . . . .

<Project>-<Component>-AD-<Version>
<Company

TABLE OF CONTENTS

1 INTRODUCTION – PART-A............................................................................................1
1.1 PURPOSE......................................................................................................1
1.2 SCOPE........................................................................................................1
1.3 DEFINITIONS, ACRONYMS AND ABBREVIATIONS.......................................................1
1.4 REFERENCES.................................................................................................1
2 ARCHITECTURAL GOALS AND CONSTRAINTS - – PART-B...........................................2
2.1 REUSABILITY.................................................................................................2
2.2 SCALABILITY................................................................................................. 2
2.3 CUSTOMIZABILITY...........................................................................................2
2.4 EXTENDIBILITY...............................................................................................2
2.5 USE OF EXISTING BUSINESS LOGIC......................................................................2
2.6 TIME TO MARKET..........................................................................................2
2.7 PORTABILITY.................................................................................................2
2.8 AVAILABILITY................................................................................................ 3
3 PRODUCTIZATION ASSESSMENT – PART-B.................................................................3
3.1 RE-USABLE COMPONENTS................................................................................3
3.2 ANALYZE ARCHITECTURAL FRAMEWORKS IN REPOSITORY...........................................3
3.3 IDENTIFY AND ANALYZE OPEN SOURCE AND COTS PRODUCTS....................................3
4 SYSTEM ARCHITECTURE – PART-A/B..........................................................................3
4.1 OVERVIEW - – PART-A..................................................................................3
4.2 LOGICAL/FUNCTIONAL VIEW - – PART-A............................................................4
4.3 USE CASE VIEW – PART-A..............................................................................7
4.4 DEPLOYMENT VIEW – PART-B........................................................................8
5 Alternative Solutions Considered – PART-B...............................................................10

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 2 <
<Company
Document Revisions
Date Version Description Author

Note: These documents are strictly for specific Virtusa use only during the Jatayu
initiative. They shall not be shared with an external party other than the client
concerned. This category also covers client intellectual property where Virtusa has a
non-disclosure agreement with the client.

Important note: The document is divided into two parts: Part-A and Part-B. Part-A shall
be completed within 10 days of commencement and submitted to your Virtusa mentors.
Part-B shall be completed and submitted at the end of the Jatayu initiative along with
your solution. Part-A at first submission can be in draft. Early submission of Part-A can
ensure that the mentors can determine if your team are on track and should there
needs be course correction.

Template User Notes:

Help Info is provided (in blue italics) to describe what each section should contain.
Sample Text is provided (in green) in some sections to assist the author in standard
wording for common documentation. Macro Buttons (in blue bold italics) must be
replaced to match the project, e.g. <Project.

Note: Help Info and Sample Text are included to provide guidance to the author and
should be deleted before publishing the document.

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 1 <
<Company

1 Introduction – PART-A
1.1 Purpose

This document provides a comprehensive architectural overview of the <Project Name


and Application Name> system, using a number of different architectural views to depict
different aspects of the system. It is intended to capture and convey the significant
architectural decisions, which have been made on the system.

1.2 Scope

[This sub-section provides a brief description of the scope of the document, i.e., the
areas affected by this project and those areas that are out of scope of the project.]

1.3 Definitions, Acronyms and Abbreviations

[This sub-section must provide definitions for all the terms, acronyms, and abbreviations
used in this document.]

1.4 References

[This sub-section must provide a complete list of all references. Identify each document
by title, document number and the version. Specify the sources from which the
references can be obtained.]

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 1 <
<Company

2 Architectural Goals and Constraints - – PART-B

[This section describes the requirements and objectives that have some significant
impact on the architecture: use of an off-the-shelf product, portability, distribution, and
reuse. It also captures the special constraints that may apply: for example, development
tools, legacy code, and so on. Document assumptions, if any, for each architectural goal
that is described.]

2.1 Reusability

User interface related components will be used for the second phase of the back-end
data server enhancement project. Therefore, the core of the UI system must be
reusable in the second phase RDBMS based enhancement project.

2.2 Scalability

The system should scale well. The limitation will be the current application and flat file
system.

2.3 Customizability

UI customization will be supported.

2.4 Extendibility

The system should be extendible to support new features and to allow modular
development.

2.5 Use of Existing Business Logic

The system should use the existing application’s business logic by moving it into a
reusable component such as a DLL.

2.6 Time to Market

Time constraints to market. This will affect the choice of technology. E.g. VB COM vs.
ATLs.

2.7 Portability

OS and database portability.

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 2 <
<Company

2.8 Availability

Uptime constraints and fault tolerance needs.

3 Productization Assessment – PART-B


3.1 Re-Usable Components

This section specifies the information relating to the reuse analysis performed by the
Productization specialist with the requirements document as input. It lists the reusable
components and describes the commonality and variability analysis

3.2 Analyze Architectural Frameworks in Repository

This section analyzes frameworks in the repository that can be reused in the architecture
under discussion.

3.3 Identify and Analyze Open Source and COTS Products

This section documents the open source and COTS products identified for use in the
project along with the copyright and legal approval needs.

4 System Architecture – PART-A/B

This section describes the software architecture of the current system, and how it is
represented. Out of the Logical, Use Case, Implementation, Process and Deployment
views, it enumerates the views that are necessary, and for each view, explains the types
of model elements it contains.

Models XML compliant tool


Diagrams .svg format

4.1 Overview - – PART-A

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 3 <
<Company
The application is comprised of several key architectural components that are
independent functions related only via the defined interfaces.
The application is divided into three tiers: User Interface Services, Business Services and
Data Services. Each layer is responsible for handling a well-defined area of the
application.

4.2 Logical/Functional View - – PART-A

This sub-section describes the system architecture at a high-level. The aim is to provide a
logical architecture diagram to document the:
 Logical components of the layers and partitions of the application
 Logical relationships between them

The application is comprised of several key architectural components that are


independent functions related only via the defined interfaces.

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 4 <
<Company
Option 1: (Use block diagrams)

FIGURE 1: Sample Project Application Architecture Overview

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 5 <
<Company
Option 2: Package and Layering Diagram (preferred)

The application is divided into three tiers: User Interfaces Services, Business Services
and Data Services. Each layer is responsible for handling a well-defined area of the
application.

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 6 <
<Company

4.3 Use Case View – PART-A

[This sub-section lists use cases or scenarios from the use-case model if they represent
some significant, central functionality of the system, or if they have a large architectural
coverage - they exercise many architectural elements, or if they stress or illustrate a
specific, point of the architecture.]
Example diagram:

Example diagram:

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 7 <
<Company

4.4 Deployment View – PART-B

[This sub-section describes one or more physical network (hardware) configurations on


which the software is deployed and run. It is a view of the Deployment model. At a
minimum, for each configuration it should indicate the physical nodes (computers, CPUs)
that execute the software, and their interconnections (bus, LAN, point-to-point, and so
on.) Also include a mapping of the processes of the Process View onto the physical
nodes.

This section also describes the deployment environment.]

Example diagram:

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 8 <
<Company

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 9 <
<Company

5 Alternative Solutions Considered – PART-B

[This section describes the alternative architectural solutions that have been considered
and explains the rationale for selecting the current solution.]

Copyright © Virtusa Template ID: TMP-AD-AD-5-002


Architecture Document for <Project Name> 10 <

You might also like