/
Design Document Template

Design Document Template

Introduction

The purpose of this document is to describe the architecture and design of [], which was initiated by ServiceNow ticket: ServiceNow #.

  • Background of the project
  • Problem Statement
  • High Level description of the solution
  • Assumptions, Scope, Dependencies

Requirements

Key Requirements

Design Considerations

Logical Design

Logical Design Diagram

  • Include all major components and entities plus their relationships, data flows and connections

Component Description/Purpose

Component NameDescription/Purpose
Component 1...
Component 2...

Physical Design

Physical Design Diagram

  • All major components and entities identified within specific physical servers and locations or specific software services, objects or solutions
  • Includes OS, version numbers, patches
  • Specs of servers (e.g, RAM, CPU, etc.)

Physical Specifications

Server/Component NameSpecs (RAM, CPU, etc.)Software/Application
   
   
   

Systemic Qualities

Authentication & Authorization

  • Requirement being addressed
  • How authentication and authorization will be handled

Security

  • Requirement being addressed
  • How security will be handled

Performance

  • Requirement being addressed
  • How performance will be handled

Availability

  • Requirement being addressed
  • How availability will be handled
  • E.g., DR, backups, etc..

Scalability

  • Requirement being addressed
  • What's the growth expectations?
  • How scalability will be handled

Maintainability

  • Requirement being addressed
  • How scalability will be handled

Cost Estimate

  • Attach cost estimate spreadsheet