Skip to content

Latest commit

 

History

History
59 lines (31 loc) · 1.44 KB

Engineering_Design_Document.md

File metadata and controls

59 lines (31 loc) · 1.44 KB

<Feature/Service name>

Status: [Draft|Final]

Authors: <...>

Objective

What is this document meant to accomplish?

Background

What’s the context of the project? What are you solving and why? What constraints informed this design?

Benefits

If your proposal is implemented, how does it benefit the company?

Goals

What exactly are you trying to do? Why? These should be measurable and specific.

Non-goals

What are you explicitly not trying to do? Why?

Alternatives Considered

Optional. What else did you consider? Why were they rejected as a solution?

Design Overview

At a high level, how is your service put together? What’s the block-level diagram for the service?

Detailed Design

Another level of detail beyond the design overview, if needed.

Performance Implications

What should we know about performance?

Security Implications

Are there known or potential security issues that should be pointed out? How are, or will they be, addressed?

Privacy/GDPR Implications

Are there known or potential privacy or GDPR issues that should be pointed out? How are, or will they be, addressed?

Logging Impacts

What kind of logs are you generating? At what volume? How long do will we expect to keep them?

Engineering Asks

What does the rest of engineering have to do if this project is implemented?

Sign-off List

Who has to sign off on this before it can move to implementation?