The System Design Document (SDD) describes the high-level system design and the low-level detailed design specifications from which a system is built. As part of the security development team, this do


Centers for Medicare & Medicaid Services

<Business Owner’s Office/Center>

<Business Owner’s Group>

7500 Security Blvd

Baltimore, MD 21244-1850

System Design Document Template

System Design Document (SDD)

Version: <1.0>

Last Modified: <Month Day, Year>

[SDD Template Version 2.0 – November 4, 2010]

Approved for use by the ILC Steering Committee

Document Number: <document’s configuration item control number>

Contract Number: <current contract number of company maintaining document>

TEMPLATE REVISION HISTORY

Version

Date

Organization/Point of Contact

Description of Changes

1.0

11/9/2007

Julie Shadoan, OIS/EASG/DITPPA

Baseline Version

1.1

8/12/2008

Julie Shadoan, OIS/EASG/DITPPA

Approved by ESD Deliverables Workgroup

1.2

9/23/2009

Kristine Maenner, OIS/EASG/DITPPA

Added sections to call out Security and Performance Hardware and Software

1.3

2/11/2010

Kristine Maenner, OIS/EASG/DITPPA

In the Detailed Design Sections, replaced reference to “component” to “service.”

2.0

11/4/2010

Celia Shaunessy,

OIS/EASG/DITG

Added Records Management information.

Note to the Author

[This document is a template for creating a System Design Document (SDD) for a given project. The SDD may be incrementally and iteratively produced during various stages of the system development life cycle, based on the particular circumstances of the IT project and the system development methodology being employed for developing the automated system. If an automated system is developed in multiple builds or releases, a revised SDD will likely be required for each major release.


The SDD may have sections that are populated from the output of multiple tools (e.g.,ERWIN, Visio, UML generation tools, DOORs etc.). In order to minimize information redundancy, the SDD may point to other related documents (e.g., Interface Control Document (ICD), Database Design Document (DDD), Information Security Risk Assessment (IS RA), etc.) in lieu of repeating information pertinent to the system design that is documented elsewhere.


This template includes instructions to the author, boilerplate text, and fields that should be replaced with the values specific to the particular project.

  • Blue italicized text enclosed in square brackets (i.e., [text]) provides instructions to the document author, or describes the intent, assumptions and context for content included in this document.

  • Blue italicized text enclosed in angle brackets (i.e., <text>) indicates a field that should be replaced with information specific to the particular project.

  • Text and tables in black are provided as boilerplate examples of wording and formats that may be used or modified as appropriate.


When using this template, follow these steps:


  1. Replace all text enclosed in angle brackets (e.g., <System Name (Acronym)>) with the appropriate information for the specific project. These angle brackets appear in both the body of the document and in headers and footers.

  2. Modify any boilerplate text as appropriate to the specific project.

  3. To add any new sections to the document, ensure that the appropriate header and body text styles are maintained. Styles used for the section headings are Heading 1 (Times New Roman 16 pt) and section sub-headings are Heading 2 (Times New Roman 14 pt). The style used for boilerplate and body text is Body Text (Times New Roman 12 pt).

  4. To update the Table of Contents, right-click and select “Update field” and choose the option “Update entire table”. Ensure that sub-headings at each level in the Table of Contents are appropriately indented for improved readability.

  5. Delete this “Notes to the Author” page and all instructions to the author (i.e., all blue italicized text enclosed in square brackets) before finalizing the initial draft of the SDD.]

APPROVALS

[Obtain signature approval of the final document from the delivering organization’s Project Manager and the primary CMS recipient (i.e., generally the Government Task Leader (GTL)). Signature approval must also be obtained from the CMS Business Owner and the CMS Records Officer. Additional signature lines may be added as needed.]

The undersigned acknowledge that they have reviewed the System Design Document and agree with the information presented within this document. Changes to this System Design Document will be coordinated with, and approved by, the undersigned, or their designated representatives.


Signature:

Date:

Print Name:

Title:

Role:

Submitting Organization’s Approving Authority

Signature:

Date:

Print Name:

Title:

Role:

CMS’ Approving Authority

Signature:

Date:

Print Name:

Title:

Role:

CMS Business Owner

Signature:

Date:

Print Name:

Title:

Role:

CMS Records Officer

REVISION HISTORY

[Use the table below to record information regarding changes made to the document over time.]

Version

Date

Organization/Point of Contact

Description of Changes

1.0

<mm/dd/yy>

<Organization Identifier / Point-of-Contact Name>

Baseline Version

TABLE OF CONTENTS

1.<System Name and/or Acronym>INTRODUCTION 1

2.REFERENCED DOCUMENTS 1

3.Overview 1

4.ASSUMPTIONS/CONSTRAINTS/RISKS 1

4.1.Assumptions 1

4.2.Constraints 1

4.3.Risks 1

5.DESIGN CONSIDERATIONS 1

5.1.Goals and Guidelines 1

5.2.Development Methods and Contingencies 1

5.3.Architectural Strategies 1

6.SYSTEM ARCHITECTURE 1

6.1.Hardware Architecture 1

6.1.1Security Hardware Architecture 1

6.1.2Performance Hardware Architecture 1

6.2.Software Architecture 1

6.2.1Security Software Architecture 1

6.2.2Performance Software Architecture 1

6.3.Information Architecture 1

6.3.1Records Management 1

6.4.Internal Communications Architecture 1

6.5.System Architecture Diagram 1

7.DATA DESIGN 1

7.1.Data Objects and Resultant Data Structures 1

7.2.File and Database Structures 1

7.2.1Database Management System Files 1

7.2.2Non-Database Management System Files 1

8.USER & MACHINE-READABLE INTERFACE 1

8.1.Inputs 1

8.2.Outputs 1

9.OPERATIONAL SCENARIOS 1

10.DETAILED DESIGN 1

10.1. Hardware Detailed Design 1

10.2.Software Detailed Design 1

10.3.Security Detailed Design 1

10.4.Performance Detailed Design 1

10.5.Internal Communications Detailed Design 1

11.SYSTEM INTEGRITY CONTROLS 1

12.EXTERNAL INTERFACES 1

12.1. Interface Architecture 1

12.2. Interface Detailed Design 1

13.GLOSSARY 1

14.Acroynyms 1

15.APPENDICES 1

[Insert a List of Figures appearing within the SDD along with a page reference for each identified figure as appropriate. Labels of Figure titles and descriptions are to be placed centered, above the figure within the main body of the document. All figures must have an associated tag providing appropriate alternative text for Section 508 compliance.]

<Figure #: Figure Title or Description……………………………………………Page Number>

LIST OF TABLES

[Insert a List of Tables appearing within the SDD along with a page reference for each identified table as appropriate. Labels of Table titles and descriptions are to be placed centered, above the table within the main body of the document.]