135 lines
4.6 KiB
Markdown
135 lines
4.6 KiB
Markdown
##### Project:
|
|
::[PROJECTNAME](Home)
|
|
|
|
##### Internal Release Number:
|
|
::X.Y.Z
|
|
|
|
##### Attached Worksheets:
|
|
- Design > [Architecture Worksheet](Design-Architecture)
|
|
- Design > [Source Organization and Build Worksheet] > (Design-Src-Org)
|
|
<!-- - Design > [Scalability Worksheet](Design-Scalability) -->
|
|
- Design > [User Interface Worksheet](Design-UI)
|
|
- Design > [Persistent Storage Worksheet](Design-Persistence)
|
|
- Design > [Security Worksheet](Design-Security)
|
|
|
|
##### Related Documents:
|
|
- [SRS](SRS) > [Use case suite](Use-Case-Suite)
|
|
- [SRS](SRS) > [Feature set](Feature-Set)
|
|
- [Glossary](Glossary)
|
|
- ::LINKS TO RELEVANT STANDARDS
|
|
- ::LINKS TO OTHER DOCUMENTS
|
|
---
|
|
|
|
**Process impact:** This design document describes a system that will
|
|
satisfy the requirements of the [SRS](SRS). Decisions made in
|
|
creating this design document are based on those requirements and an
|
|
understanding of available technologies and components. Once the design
|
|
has been drafted, work on the system implementation and unit testing may
|
|
begin.
|
|
|
|
*TODO: Fill in the sections below. Add ore remove items as needed for
|
|
your project.*
|
|
|
|
### Introduction
|
|
|
|
#### How is this design document organized?
|
|
This main page describes the system design in terms of packages,
|
|
classes, relationships, and behavior. Several attached worksheets
|
|
address specific aspects of the overall system design, such as user
|
|
interface and database design.
|
|
|
|
#### What are the most important facts that a developer should know about this design?
|
|
::PARAGRAPH or BULLETS
|
|
|
|
#### What are the prioritized goals of this design?
|
|
1. ::[Correctness](Glossary-Standard-Terms#dg_correctness)
|
|
2. ::[Feasibility](Glossary-Standard-Terms#dg_feasibility)
|
|
3. ::[Understandability](Glossary-Standard-Terms#dg_understandability)
|
|
4. ::[Implementation phase guidance](Glossary-Standard-Terms#dg_guidance)
|
|
5. ::[Modularity](Glossary-Standard-Terms#dg_modularity)
|
|
6. ::[Extensibility](Glossary-Standard-Terms#dg_extensibility)
|
|
7. ::[Testability](Glossary-Standard-Terms#dg_testability)
|
|
8. ::[Efficiency](Glossary-Standard-Terms#dg_efficiency)
|
|
|
|
### UML Structural Design
|
|
|
|
*TODO: Link to a design model and/or design diagrams that describe your
|
|
system's structure in detail.*
|
|
|
|
#### The system's structural design is described in the following UML model:
|
|
::[MODELNAME](LINK-TO-MODEL-FILE).
|
|
|
|
#### The system's structural design is described in the following UML structural diagrams:
|
|
|
|
- ::[PACKAGE OVERVIEW DIAGRAM](LINK-TO-DIAGRAM)
|
|
- ::PACKAGENAME
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::PACKAGENAME
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::PACKAGENAME
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
|
|
::ANY ADDITIONAL NOTES OR COMMENTS
|
|
|
|
### UML Behavioral Design
|
|
|
|
*TODO: Link to a design model and/or design diagrams that describe your
|
|
system's behavior in detail.*
|
|
|
|
#### The system's behavioral design is described in the following UML model:
|
|
::[MODELNAME](LINK-TO-MODEL-FILE)
|
|
|
|
#### The system's behavioral design is described in the following UML behavioral diagrams:
|
|
|
|
- State Diagrams
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- Sequence Diagrams
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- Collaboration Diagrams
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
- ::[DIAGRAMNAME](LINK-TO-DIAGRAM)
|
|
|
|
::ANY ADDITIONAL NOTES OR COMMENTS
|
|
|
|
### UML Design Checklist
|
|
|
|
*TODO: Answer the following questions to help evaluate your design. Add
|
|
or remove questions to fit your project. If you cannot answer a question
|
|
positively, that may indicate an aspect of the design that should be
|
|
revised.*
|
|
|
|
#### Correctness: How do you know that this design is correct?
|
|
::2-4 SENTENCES
|
|
|
|
#### Feasibility: What indicates that this design can be implemented and tested with the planned amount of time and effort?
|
|
::2-4 SENTENCES
|
|
|
|
#### Understandability: What makes this design understandable?
|
|
::2-4 SENTENCES
|
|
|
|
#### Implementation phase guidance: Does the design suggest reasonable implementation tasks?
|
|
::2-4 SENTENCES
|
|
|
|
#### Modularity: How have concerns been separated and addressed in distinct modules?
|
|
::2-4 SENTENCES
|
|
|
|
#### Extensibility: How can new features can be easily added later?
|
|
::2-4 SENTENCES
|
|
|
|
#### Testability: What makes this system easy to test?
|
|
::2-4 SENTENCES
|
|
|
|
#### Efficiency: Does the system consume an acceptable amount of time, storage space, bandwidth, and other resources?
|
|
::2-4 SENTENCES
|
|
|
|
#### Has the design been communicated to the development team and other stakeholders?
|
|
- ::Yes, everyone understands. Feedback is welcome.
|
|
- ::No, this is a risk that is noted in the
|
|
[Risk Management](Project-Plan#risks) section.
|