design

advertisement

Project Name

Document Version 1.0

Prepared by Jane Doe, ITS

Last Edited April 13, 2020

PLAN REQUIREMENTS

SOLUTION

ANALYSIS

DESIGN BUILD TEST TRAIN/DEPLOY MAINTENANCE

TO THE DOCUMENT OWNER: This template is provided as a guideline and resource. The structure and instructions give detail about what might go into a completed document. Only you and your team, however, know what will best fit the needs of your specific effort, and you are encouraged to adapt the template as appropriate to meet those needs.

Design Blueprint

Executive Summary .............................................................................................................................. 2

High-Level Design ................................................................................................................................. 2

System Architecture Overview ..................................................................................................................... 2

System Interface Overview ........................................................................................................................... 2

Data Overview ............................................................................................................................................... 2

Detailed Design ...................................................................................................................................... 3

System Component Overview ...................................................................................................................... 3

System Component A.................................................................................................................................... 3

Sub-Element A1 ......................................................................................................................................... 3

Sub-Sub-Element A1.a .......................................................................................................................................... 3

User Interface Design .................................................................................................................................... 4

User Interface Workflow ........................................................................................................................... 4

User Interface Mock-up A ......................................................................................................................... 4

Programmatic Interface Design .................................................................................................................... 4

Programmatic Interface Workflow ........................................................................................................... 4

Programmatic Interface A ......................................................................................................................... 4

Data Design ................................................................................................................................................... 4

Data Conversion and Migration .................................................................................................................... 5

Auditing and Logging Design ......................................................................................................................... 5

Monitoring and Service Statistics Design ...................................................................................................... 5

Environment Design ...................................................................................................................................... 5

Other Design Features .................................................................................................................................. 5

Glossary ......................................................................................................................................................... 6

Appendices .................................................................................................................................................... 6

Revision History ............................................................................................................................................ 6

Signatures ..................................................................................................................................................... 6

Page 1 of 6

Project Name

Document Version 1.0

The Design Blueprint builds upon the Business Process Workflow and Solution Diagram documents, outlining the design and plan for the new or upgraded system in more detail. Its primary purposes are:

 Facilitate the project team's exploration of the detailed design

 Communicate a high-level view of the design to audiences outside the project team

 Provide a subject for design reviews

 Record design decisions and their rationale

The Design Blueprint provides both high-level and detailed design information; for a project with separate high-level and detailed design phases, the sections for completion in each phase are marked.

Not all sections below will be applicable to every project. Design for disaster recovery purposes is covered in a separate document.

Executive Summary

Provide a summary of the scope of the new or upgraded system to be produced, focusing on the highlevel architecture and system interfaces.

High-Level Design

System Architecture Overview

Provide and describe a figure that depicts the overall system architecture. This figure should elaborate on the Solution Diagram and illustrate the next lower level of detail. Describe how the system architecture relates to and supports the Business Process Workflow.

System Interface Overview

List the interfaces into the system, including graphical, programmatic, and intra-component interfaces.

If not included in the system architecture, provide a figure depicting the interfaces. Describe the audience for each interface, along with its relationship to the Business Process Workflow.

Data Overview

List the high-level data objects that will be handled by the system and define each from the perspective of the business process. If not included in the system architecture, provide a figure depicting the data repositories and their relationships to the system. Provide an overview of the actions that will be taken on system data.

Design Blueprint Page 2 of 6

Detailed Design

Project Name

Document Version 1.0

System Component Overview

Provide an overview by listing the major functional pieces (components) of the system, along with the relationship of each to other system components. Most systems may be broken down in multiple ways, so the division into components is up to the project team to define. Identify each component within the system architecture, interface, and data overview figures. Modify the table below as appropriate to provide a view of relevant connections among the parts of the system.

Component

Component A

Component B

Component C

Component D

Component E

Component F

Figure

ID

Data:

G

Receives Data From

Component F,

Component B

Sends Data To

Component D,

Component F

System Component A

For each component, provide a figure depicting its sub-elements and their relationships, if applicable.

Customize this section to contain the subsections necessary to document the component and its subelements fully. Use figures and lists to clarify interactions and hierarchies in the design. Describe each component and sub-element within the design in detail, including its relationship to other components and its role in the overall architecture. At the lowest level, provide details about the element's hardware and software, configurations, limitations, and the like.

Sub-Element A1

Describe the design of sub-element A1 and its relationship to other system components.

Sub-Sub-Element A1.a

Describe sub-sub-element A1.a and its relationship to other system components.

Design Blueprint Page 3 of 6

User Interface Design

Project Name

Document Version 1.0

User Interface Workflow

Provide and describe a diagram of the workflow that illustrates how a user moves through the user interface(s). Indicate which Use Cases are fulfilled by each interface.

User Interface Mock-up A

Provide a description and an image or mockup of each screen, report, or other user interface. Provide descriptive information for each field that appears in the interface, including details such as acceptable values and validation methods, calculations and algorithms, and whether the information is modifiable.

Detail any variants of the page, such as error messages and displays, differing views for different permission levels, and no-data conditions.

 Will the interface need to be available for mobile users? How will the interface be modified for this audience?

Programmatic Interface Design

Programmatic Interface Workflow

Provide and describe a diagram of the workflow that illustrates how data moves through the programmatic interface(s). Indicate which Use Cases are fulfilled by each interface.

Programmatic Interface A

Provide a description of each programmatic interface, including its intended audience. Describe the interface technology, protocol, authorizations and security measures, and other connection details.

Provide a list of the data that will be accessed via the interface, for both incoming and outgoing cases.

Include descriptive information for each field that appears in the interface, including details such as acceptable values and validation methods, calculations and algorithms, and data formats. Detail any variants of the information exchange, such as error messages and displays, differing sets of data for different permission levels, and no-data conditions.

Data Design

Describe the data contained in databases and other data structures in the system. Provide an illustration of the logical data model or entity relationship diagram(s) for the system. Include the purpose and general configuration of the data store. Describe the physical data model, with details such as constraints and dependencies between fields.

 What data will need to be stored for tracking and historical information? For static data elements (e.g., standard value lists, drop-down menus, etc.) and data control tables?

Design Blueprint Page 4 of 6

Project Name

Document Version 1.0

Data Conversion and Migration

Provide a description of any data which will need to be converted and/or migrated as part of the project.

Detail the process for conversion and/or migration. List each field which will be included in the conversion and/or migration, including specific transformation details. Describe how data will be validated prior to and following the conversion and/or migration.

 Will all data be converted and/or migrated?

 How will invalid data on the source file be handled?

 If the source data continue to be available - for example, for historical purposes - will there need to be mapping between the new and old data sources?

 If the project involves moving between product or database versions, will this affect the data migration?

Auditing and Logging Design

Describe the logging features of the system and the data which will be captured for logging and auditing purposes.

 How long will log data be retained? What processes will be used to remove data after the required retention period?

Monitoring and Service Statistics Design

Describe the mechanism(s) for monitoring the availability and response of the system, including notification in the event of failure. Document the tools and interfaces that will be used to track service usage and generate performance statistics.

 Can the service be effectively monitored as a whole, or do individual components need specific monitoring?

 Should the response to failure in different elements of the system be the same, or are some system components more important than others?

 If the system is in the cloud, how should monitoring with the cloud provider be configured?

Has redundant monitoring on campus been planned as well?

Environment Design

Describe the different system environments to support development and testing as well as production.

Provide and describe a figure for each environment, including indicators of the differences between them. Document the purpose for each environment and the rationale behind any differences in design.

Other Design Features

Describe any design features that are not captured in the previous sections.

Design Blueprint Page 5 of 6

Project Name

Document Version 1.0

Glossary

Define all terms and acronyms required to interpret the Design Blueprint properly. It may be appropriate to reference another document or other external source.

Appendices

Include any relevant appendices.

Revision History

Identify changes to the document.

Version Date Updater Name Description

Signatures

Formal written signoff is preferred for larger, more complex projects.

Name Role Signature Date

Design Blueprint Page 6 of 6

Download