System Design Template
description
Transcript of System Design Template
Coyote document
System Design Template
Table of Contents
TOC \o "1-4" Table of Contents GOTOBUTTON _Toc389991569 PAGEREF _Toc389991569 1
Overview GOTOBUTTON _Toc389991570 PAGEREF _Toc389991570 2
Intended Audience GOTOBUTTON _Toc389991571 PAGEREF _Toc389991571 2
Authors GOTOBUTTON _Toc389991572 PAGEREF _Toc389991572 2
Related documents GOTOBUTTON _Toc389991573 PAGEREF _Toc389991573 2
Introduction GOTOBUTTON _Toc389991574 PAGEREF _Toc389991574 2
State Transition Models GOTOBUTTON _Toc389991575 PAGEREF _Toc389991575 2
Event Models GOTOBUTTON _Toc389991576 PAGEREF _Toc389991576 3
Data Forms GOTOBUTTON _Toc389991577 PAGEREF _Toc389991577 3
Significant New Features GOTOBUTTON _Toc389991578 PAGEREF _Toc389991578 3
Implementation Specifications GOTOBUTTON _Toc389991579 PAGEREF _Toc389991579 3
Business Rules and Design Specifications GOTOBUTTON _Toc389991580 PAGEREF _Toc389991580 3
Phase 1 - Initial Implementation GOTOBUTTON _Toc389991581 PAGEREF _Toc389991581 4
GOTOBUTTON _Toc389991582 PAGEREF _Toc389991582 4
GOTOBUTTON _Toc389991583 PAGEREF _Toc389991583 4
Minor category GOTOBUTTON _Toc389991584 PAGEREF _Toc389991584 4
Phase 2 - Advanced Implementation GOTOBUTTON _Toc389991585 PAGEREF _Toc389991585 4
GOTOBUTTON _Toc389991586 PAGEREF _Toc389991586 4
Design Notes GOTOBUTTON _Toc389991587 PAGEREF _Toc389991587 4
Overview
A brief summary of the system to be designed. It might specify data and control models, entity-relationship diagrams, event models, state models, or other architectural models which make up the major aspects of the system.
Intended Audience
Describes the intended audience for this document, possibly including designers, users, other affected groups, sponsors, or other management.
Authors
The system was designed by the team:
Related documents
Lists related documents, such as requirements specifications, APIs, Charters, Product Vision and Mission statements.
(Draft #- - )
Introduction
A more detailed explanation for why the systems is being built. It has a bullet list of the major requirements such a system would fulfill. Other items to be listed could be any major assumptions made, major elements of the system, special terms with definitions..
State Transition Models
Description of state transition models, including diagrams and state tables.
Start State Next StateEventsActions by the SystemData InvolvedUsersEvent Models
Description of event models, including diagrams and event tables.
Key EventStimulusFrequency of OccurrenceResponseMemoryModeData Forms
All data forms (if any).
Significant New Features
List new features.
Implementation Specifications
The following sections are low-level design specifications.
Business Rules and Design Specifications
The design is specified by two types of items: business rules, and design specifications, each having a tag which uniquely identifies it. Most of the items were originally design issues, which have been translated into either business rules, or design specifications. Numbering is roughly in order of resolution. The form of these items is:
br-ddA Business Rule describing some automatic aspect of the system, where br represents Business Rule, and dd is a unique integer (to business rules).
ds-ddA Design Specification describing some element, data definition, security or other aspect of the system, where ds represents Design Specification, and dd is a unique integer (to design specs).
Specifications have implementation status which is classified as follows:
Plain text with no annotation means the specification is implemented as stated.
Text enclosed in a shadow box is or has outstanding issues.
Text that has background grayed has not been implemented for some reason.
Phase 1 - Initial Implementation
These are the specifications for the first phase of implementation.
br-05
ds-59
br-12
ds-59
Minor category
-
Phase 2 - Advanced Implementation
Specifications which may be included in a later version, but which may have been taken into consideration during phase 1..
ds-20
Design Notes
A list of issues or other considerations concerning the difference between this and earlier phases.
University of California Santa Cruz Extension
Software Requirements, Analysis, & Design
Design Specification Template PAGE 1Brian Lawrence 5/28/98