Skip to content

Commit

Permalink
Add design doc template from Adrianna Foster
Browse files Browse the repository at this point in the history
  • Loading branch information
billsacks committed Sep 15, 2022
1 parent a5e6218 commit 11d589f
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions doc/design/design_doc_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Software Design Documentation

<span style="font-size:larger;"><b>Project Name</b></span>

**Date:**:

**Written By**:

## Introduction
---------------------------------------
*What is the goal of the software? What is the problem statement?*

If there are any specification documents, link them in Appendix.

## Solutions
---------------------------------------
*Section should include alternative implementations/solutions*

Is it feasible? How much effort does it need for each approach? Pros/cons of each approach.

Document alternatives, why you made the decision and how it will affect the team and project.

## Design Considerations
---------------------------------------
Describe the issues that need to be addressed before creating a design solution.

### Assumptions and Dependencies:
Describe any assumptions that may be wrong or any dependencies on other things

### General Contraints:
Describe any constraints that could have an impact on the design of the software.

## Design and Architecture
---------------------------------------

### System diagram or flowchart
Interaction diagram of various inputs, outputs, sub systems and dependencies.

### Algorithm or Pseudo code for main components
Describe your logic in this section

## Rollout Plan
---------------------------------------
Define the roll-out phases and tests you plan to do

## Appendix
---------------------------------------
References, links to additional documentation

## Review Sign-off
---------------------------------------
* Team lead:
* Sponsor:

*Sign-off Completed on YYYY-MM-DD*

0 comments on commit 11d589f

Please sign in to comment.