Introduction
Give a brief overview of what you are designing. What purpose does it serve? What feature does it provide to the end-user? Keep it high-level and delve into the technical details in the sections below.
Requirements
Insert references to any relevant requirements here.
Constraints
What constraints might affect the design? Performance? Ease of use? Execution environment or Operating System? Other system components?
Use Cases
If developing use cases to better understand what the design should do is helpful, document it here and include use case diagrams if necessary.
Detailed Design
Explain the design in-depth. Use technical language to explain the design principles and technologies used. Consider and explain how the design fits into the overall system. Include block or class diagrams if necessary to illustrate the design.
System Interaction
Explain how and in what order this design interacts with other components of the system or with the end-user. Include sequence diagrams if necessary to illustrate the order of events.
User Interface / User Experience
If the design has a visual component, include considerations for the interface to the design and the end-user experience of that interface. Include wireframe diagrams or mockups if necessary to help illustrate the considerations.
Glossary
List any acronyms, abbreviations, and/or technical terms that you have used throughout this document.
Term | Description |
---|---|