03 - sdd - solution design document

Solution Design

Document (SDD)

Project Name: [Full Name]

Project Code: [8 character Code]

Version: X.X

Author: [Your Name]

Position: [Your Position]

Phone: [Your Phone Number]

1. Email: [Your Email Address]

[Company] Page 22 of 22 SDD – [Client / Project]

Document History

Version Responsible Date Notes

1.0

*** End of Revision List

***

Table 1Document History

1. Contact for Enquiries and Proposed Changes

If you have any questions regarding this document contact:

Name: Marc Dimmick

Designation: System Business Anaylsis

Phone: (08) 6216 6335

Email: [email protected]

If you have a suggestion for improving this document, complete and forward a copy of Suggestions for Improvements to Documentation .

2. Record of Issues

The Record of Issues reflects revisions to this template. This information should be deleted from your document.

Ver Date Nature of Amendment

1.0 12 Apr 2006 Initial Document

1.1 8 Jun Update Layout and style sheet

1.2 23 Nov 06 Update Layout and Style

1.3 19 Jul 2007 Update Corporate Logo

[Company] 2 of 22 SDD – [Client / Project]

http://www.google.com/url?q=http%3A%2F%2Fwww.in.telstra.com.au%2Fism%2Fcompanydocumentstandards%2Fformsattachments.asp&sa=D&sntz=1&usg=AFQjCNH05hQEjyOxX_8crLlQJCUioeeZBA





2. Guidelines for completion of this Document:Consultants are required to gathering and documenting requirements in consultation with project stakeholders. Overall Responsibility for this lies with the project lead.This template ensures that the essential details pertaining to this Requirements document a clear and unambiguous statement of Functional and Non-Functional Requirements.This document is used in development, testing, quality assurance, project management, and related project functions.Items in squared brackets are to be replaced with appropriate contents. For example, [Project Manager] should be replaced by the name of the Project Manager.This template provides a recommended structure and format along with sample contents, explanatory notes and questions to guide and prompt the author.Please delete these notes and other guidelines from the actual document. They are meant for your information only. These are given in this colour and font. If a section/ subsection are not applicable, do not delete it. Instead, mention as such and explain why it is not applicable. Remember to run a spell check. It is preferable to use date with month name rather than month number to avoid confusion (use Jan 2, 2006 or 2 Jan 2006, instead of 1/2/2006 or 2/1/2006) This document contains pre-formatted styles for headings. To convert a line into heading, select the line and choose BS Heading 1, BS Heading 2, etc., as appropriate from the style drop down adjacent to the font drop down box

Table of Contents1 Document History 2

1.1 Contact for Enquiries and Proposed Changes 21.2 Record of Issues 2

2 Guidelines for completion of this Document: 33 [Client / Project] 6

3.1 Purpose 63.2 Project Overview and Status 63.3 Project Objectives / Problem Statement 6

4 Project Scope 74.1.1 Inclusions 74.1.2 Exclusions 74.1.3 Phasing if required 7

4.2 Key Stakeholders 74.3 Project Related and Other Reference Documents 7

5 Architectural Overview 85.1 Target Interfaces 8

6 Architectural Decisions 96.1 Key Architectural issues 96.2 Architectural Risks and Assumptions 9

7 Solution Description 107.1 Component Model 10


7.2 Re-use of components 107.3 Information Model 10

7.3.1 Information and Data Characteristics 117.4 Infrastructure Model 117.5 Integration and Network Design 117.6 Security Architecture 11

7.6.1 Application Security 117.6.2 Operational Security 12

8 System Requirements 138.1 [system / component name] 13

8.1.1 Relevant Flow Chart 138.1.2 Solution Architecture Requirements 138.1.3 Design Description 13

9 Implementation and Migration 149.1 Architecture Migration Plan 14

9.1.1 Migration Plan 149.1.2 List Dependencies 14

9.2 GLOSSARY 14

10 functional Requirements 1510.1 Requirement – [Function 1 Title] 1510.2 Outputs 1510.3 Screens 1510.4 Reports 1510.5 Requirement – [Function 2 Title] 1510.6 Outputs 1610.7 Screens 1610.8 Reports 16

11 Inputs 1711.1 Data 1711.2 Applications 1711.3 Third party 17

12 Design 1812.1 Colours 1812.2 Look and Feel 1812.3 Usability Issues 1812.4 Audience 18

13 Performance 1914 Data Migration and Conversion 2015 APPENDICES 21

15.1 Definitions 2115.2 Attachments 21

16 Sign-off list 22

Tables

Table 1Document History 2


Table 2 - Project Objectives / Problem Statements 6Table 3 -Key Stakeholders 7Table 4 -Project Related and Other Reference Documents 7Table 5 - Architectural Decisions 9Table 6 -Key Architectural Issues 9Table 7 - Architectural Risks and Assumptions 9Table 8 - Relevant Flow Charts 13Table 9 - Glossary 14Table 10 - Functional Requirements 15Table 11 - Functional Requirements 16Table 12 - Definitions 21Table 13 - Attachments 21


3. [Client / Project]1. Purpose

The primary purpose of this document is to communicate the essential elements of the overall solution so that business implications can be assessed and understood, and so that the design activities in Build/Acquire can proceed if the initiative is approved.Insert description of technical development and what will be achieved upon successful implementation of the solution described in this document.

2. Project Overview and StatusProvide the background and context of the initiative, and its current status from a project perspective.The current status should also include any significant risks or issues that may be relevant to the design.

3. Project Objectives / Problem StatementProvide a brief overview of the objectives of the project, eg, an overview of a new product or a new feature, or a new support system, etc. Include a brief summary of the business need and drivers behind the initiative, as well as enterprise, design and standards constraints. EG, include forecast growth, peak traffic/transaction volumes, and reference market projections, etc. Refer to the BRD for detail.Alternatively the objective may be best described as an initiative to solve a problem. The table below provides a suggested format for the problem statement.

The problem of

Affects

The impact of which is

A successful solution would

4. Table 2 - Project Objectives / Problem Statements


Project ScopeInsert a statement that describes the project scope.

1. Inclusions

2. Exclusions

3. Phasing if required2. Key Stakeholders

Area / Position Name / Role Contact Number

Business Stakeholders

Technology Stakeholders

Operations Stakeholders

Table 3 -Key Stakeholders

3. Project Related and Other Reference DocumentsList all the references that were used in coming up with this document.

Document ID Title / Description / Location

Project Related Documents

Other Reference Documents

5. Table 4 -Project Related and Other Reference Documents


Architectural OverviewInsert architectural diagram of systems, interfaces and information flows of the planned solution.Number each interface for reference below.

1. Target Interfaces

Key Interface Purpose/Description

Eg. 1 Eg. Solomon, Startrack E.g. Existing interface, provides end of day manifest information for shipping purposes.


6. Architectural DecisionsInclude a summary of significant decisions made in deriving the solution here.

Architectural Decision Identifier Description

AD-01

Eg.How will invoicing occur for returned orders?

Invoicing will occur through a daily batch process between…

AD-02

…

Table 5 - Architectural Decisions

1. Key Architectural issues

Issue Identifier System(s) Impacted Description Owner Status

ISS – 01 Identify system(s) impacted by system name as described in this document

Issue to be documented in this section eg

01/01/2003: It is not clear whether XXX will generate error message axe.

Owner of the issue who will be managing it to resolution

Closed/Open

ISS – 02

….

Table 6 -Key Architectural Issues

2. Architectural Risks and Assumptions

Key architectural risks and assumptions are as follows:NB, risks to be managed by project risk management

Risk Assumption System(s) Impacted Description

AR – 01

Identify system(s) impacted by system name as described in this document Eg.Forecasting Portal

Eg. It is assumed that the migration to Microsoft .Net Framework for this portal will not impact the functionality of systems interfacing to this portal currently.

7. Table 7 - Architectural Risks and Assumptions


Solution DescriptionThis section describes the High Level solution in terms of the systems/components and how each component interacts with other systems/components.

1. Component ModelInclude and describe the component model of the design. A component is any deployable element of architecture. It is characterised by its behavior or function as exposed or expressed via an external interface. Components can be decomposed or aggregated into other components. Examples include a program, a software module, a system, a data repository, a network element, etc. Each component can utilise the services provided by other components, as well as provide services of its own.The component model describes how sets of components participate in defining the design. It includes static and dynamic relationships and interactions between components. The model documentation typically includes a number of diagrams expressing the different kinds of relationships — for example, dependency relationships, usage relationships, interaction and timing relationships, etc. Where the solution has been partitioned, the individual subsets of the component model must be clearly defined, and the assignment to the respective providers identified. Each subset will subsequently be the subject of a Design Component Specification and is usually defined by the Client(s) based on which he provides a cost and time estimate to a confidence level specified by the Project Manager.It is useful to recognise the following interface categories:

● User Interfaces — those interactions which exist to enable human interaction with the system;● Application Services Interfaces — those interactions which enable the application services

provided by one system to be utilized by another in an automated manner;● Operational Interfaces — those interactions which are used to manage and operate the systems

environment, including monitoring, recovery and exception management;● System Synchronization Services Interfaces — those interactions that are used to maintain

persistent reference and state information integrity across multiple systems in a synchronised manner.

In specifying interfaces and services, it is important to understand that there are two important cases:

● Functional Services — this case involves services that are primarily stateless, and there is a one-to-one correspondence between interface and service. Each such service can be described independently.

● Process Services — this involves services that implement a process, and behaviour is dependent upon previous activity. Typically, a single process may involve many interface calls — calls are sometimes referred to as “triggers” and in this case it is necessary, not only to describe each of the interfaces but also the state behaviour of the process itself.

2. Re-use of componentsIt is important to identify services, components, code, documentation, etc that are candidates for corporate reuse and to design and maintain baseline documentation in a way that enables that re-use at minimized cost. In this section describe what has been achieved in reuse, and any issues arising.

3. Information ModelInclude (or reference) and describe the information model pertinent to the solution. The Information Model covers a structured view of the business, system and state information that is the subject of the design. The information model does not need to address objects or data which are not exposed (or likely to be exposed) externally.


For data management intensive solutions such as those Databases of Record, this part of the solution will form a significant proportion of the total, and may actually be contained in separate documentation that is explicitly referenced by title, date and version.Whilst the information passed and returned by each interface is described in the Component Model, in most cases it is also appropriate to describe the consolidated information model.Where the solution has been partitioned, the individual subsets of the information model must be clearly defined, and the assignment to the respective providers identified.

1. Information and Data Characteristics

Regardless of the complexity or size of the information model, define the required non-functional characteristics of the model elements (or groups of elements). The characteristics to be addressed may include, but are not limited to:

● Persistence — indicate which elements of the model must persist beyond a transaction or session, including the conditions under which persistence may no longer be required, and the period of persistence;

● Size — indicate the anticipated number of instances of each element;● Security and Privacy — indicate which elements are of a particularly sensitive nature requiring

specific access or disclosure measures, or privacy constraints; ● Legal and Regulatory — indicate which elements require specific data retention, archiving, audit

trail logging, or other measures to meet legal or regulatory obligations. All legal and regulatory requirements concerning information or data should be identified as being as such even if listed under other topic headings (e.g. privacy requirements imposed by a government regulator should be identified as being legal and regulatory requirements even if they are listed under security and privacy);

● Integrity — indicates any specific integrity or validity requirements associated with the information elements.

4. Infrastructure ModelFor IT systems an infrastructure model may be required where the underlying servers, storage media, etc, are defined. (In IBM terms - the operations model)

5. Integration and Network DesignApplies to an IT systems design where the underlying communications network must be defined. Define the conceptual aspects of network or integration mechanisms required to interconnect components. The Component Model addresses interface mechanisms, principally from an application or service level perspective. Here is included additional information relating to the communication mechanisms, protocols or network models. Typically, details of this subsection are further developed as part of the Integration Specification.Both functional and non-functional characteristics of integration and network behaviour should be included.

6. Security ArchitectureThe purpose of this section is to describe the security controls that will be incorporated into the solution.

1. Application Security

Describe the following:

● Authentication. How will users authenticate to the system, describe detailed password rules. Describe where external authentication infrastructure is being used, eg account-01.


● Authorisation. Describe the categories of users and the functionality they will have. Include all users, customers, staff, operations staff supporting the platform

● Audit/Logging. Describe what will be logged and describe any external auditing or logging platforms being used

2. Operational Security

Describe at a high level any security related process and how the system will support these processes:

● How do users register or enrol with the service? How are authentication credentials issued and reset?

● How are users access rights determined and implemented? Will approval processes for user access be developed, if so by whom?

● How are users access rights revoked?● Cryptographic key management processes● Security Incident Response process● Vulnerability management – including application of patches and vulnerability assessments

8. Special information classification and handling processes


System Requirements1. [system / component name]

Complete one per system/component

1. Relevant Flow Chart

Flow Chart ID Flow Chart Name

FCXX

Table 8 - Relevant Flow Charts

2. Solution Architecture Requirements

The purpose of this section is to define the specific, well-formed requirements for impacted systems, and partition them in a manner that will facilitate design definition. When creating Architectural Requirements, each verifiable requirement defined in this section should be contained in a separate paragraph.The source of all raw requirements should be captured in the Requirements Traceability Matrix, along with the cross-reference to the labelled requirements in this section. This section contains the specific solution architecture requirements for [System/Component Name].

3. Design Description9. This section details the client’s design response pertaining to the specific system/component that is to be

delivered. If a specification document has been referenced in this section, ensure the relevant document has been attached in the appendix section of this document.


Implementation and MigrationAddress the overall approach to implementation. This would include strategy for migration from existing processes and systems, as well as data migration considerations. Typically this section will define phases of implementation that would minimise the impact on business operation whilst providing additional business value with each phase.

1. Architecture Migration Plan1. Migration Plan

Insert an Architecture Migration Plan. This plan should address the overall approach to implementation of the new architecture and complement the details written in section 6 Implementation and Migration. Examples of the types of information which may be found here are:

● the sequencing of the migration● new infrastructure requirements● list of any potential technology or infrastructure retirements caused by this plan● business impacts● plan for data migration

2. List Dependencies

This section should contain any dependencies of the plan from the section above. All issues and risks identified should be managed via the [Company] issues and risk management processes.All Assumptions of this plan and dependencies should list listed in the section Architectural Risks and Assumptions.

2. GLOSSARY

Term / Acronym Definition / Expansion / Description

Table Data Table Data

10. Table 9 - Glossary


functional Requirements1. Requirement – [Function 1 Title]

Title

BR-FID 99 FRID

Priority 1 Phase 9

Flow of Events

Steps of the requirement. Describe them as a bulleted/ numbered list

Goal the outcome of this set of actions eg User is Logged on to Solution

Sub-functions,

FID

Title

Assumptions

Any assumptions operating in the execution of the function


eg: The User is registered or logged in already. The solution will recognise each individual’s rights. If the user cannot be identified the solution will notify admin. The solution automatically saves the session settings.

Pre-conditions

What are the requirements for this flow chart to run, list of condi


tions that should exist before the process can be executed eg: User has a running drift session and has accessed the solution. User has access rights. User has been added to the list of users….etc.

Post Conditions

What state the solution is in after the process runs eg: User has access to the appli


cation according to his privileges

User Interface

Reference to UI prototype or specific screen and UI related notes

Business Rules

What conditions apply to the function? Any domain specific knowledge or algorithms or validation rules (relevant to this use-case) eg. After three unsuccessful attempts at log in the solution


will lock the user out and notify sys admin.

Related Flow Chart or Processes

This is optional. List all Flow Charts, include, extend or specialise this Flow Chart or related Flow Charts

Issues Clarifications required from user. Any questions related to the Flow Chart

References

Requirement #, Documents, Persons

Notes Any notes which


may help to clarify the process and available information or options for completion of the task. Eg: username and password will be the same as for their staff account.

Table 10 - Functional Requirements

The above grid is to be used for every function identified.If needed copy flow chart from BRD into this section of the document.

2. Outputs3. Screens4. Reports5. Requirement – [Function 2 Title]

Title

BR-FID 99 FRID

Priority 1 Phase 9

Flow of Step


Events s of the requirement. Describe them as a bulleted/ numbered list

Goal the outcome of this set of actions eg User is Logged on to Solution

Sub-functions,

FID

Title

Assumptions

Any assumptions operating in the execution of the function eg: The User is registered or logged in already. The solution will


recognise each individual’s rights. If the user cannot be identified the solution will notify admin. The solution automatically saves the session settings.

Pre-conditions

What are the requirements for this flow chart to run, list of conditions that should exist before the process can be executed eg: User

[Company] of 22 SDD – [Client / Project]

has a running drift session and has accessed the solution. User has access rights. User has been added to the list of users….etc.

Post Conditions

What state the solution is in after the process runs eg: User has access to the application according to his privileges

User Interface

Reference to UI prototype or specific


screen and UI related notes

Business Rules

What conditions apply to the function? Any domain specific knowledge or algorithms or validation rules (relevant to this use-case) eg. After three unsuccessful attempts at log in the solution will lock the user out and notify sys admin.

Related Flow Chart or Processes

This is optional. List


all Flow Charts, include, extend or specialise this Flow Chart or related Flow Charts

Issues Clarifications required from user. Any questions related to the Flow Chart

References

Requirement #, Documents, Persons

Notes Any notes which may help to clarify the process and available information or options


for completion of the task. Eg: username and password will be the same as for their staff account.

Table 11 - Functional Requirements

The above grid is to be used for every function identified.If needed copy flow chart from BRD into this section of the document.

6. Outputs7. Screens11. Reports


Inputs1. Data2. Applications12. Third party


Design1. Colours2. Look and Feel3. Usability Issues13. Audience


Performance14. Outline the performance capabilities and constraints of the solution.


Data Migration and Conversion15. If an application is to be modified, indicate here if any data conversions are required on existing data

records. If a new application is replacing an existing application, indicate here what data migration / conversion is required


APPENDICESList those documents which would be useful for the reader of the Architectural Design Document

1. Definitions

The following words, acronyms and abbreviations are referred to in this document.

Term Definition

Table 12 - Definitions

2. Attachments

Document Number Title

16. Table 13 - Attachments


Sign-off list

Project Lead _____________________ ____/____/______[Position Title]

Consultant _____________________ ____/____/______[Position Title]

xxxxx _____________________ ____/____/______[Position Title]

XXXXX _____________________ ____/____/______(Development Mgr)
