Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 784 Bytes

design.md

File metadata and controls

44 lines (28 loc) · 784 Bytes

Design document

Purpose

What does it do? What is the problem it is trying to solve? Why does it need to exist? Who will use it?

High level entities

What does it do? Reasoning for defining it?

Low level design

For each entity

Usage

What function does it serve? How is it used? What does it interface with? Does it have a public interface? Explain the thought process List benefits and risks

Configuration

Does it need something to work in the first place? If required; otherwise can be removed

Model

Describe relationship; does not have to be perfect

Interaction

Describe communication; makes sure interaction between submodules are correct

Benefits/Assumptions/Risks/Issues

5/6 top benefits All known risks/issues All assumptions