Engineering team hub

Explore

Design Docs

Design Doc [Template]

Last edited 355 days ago by Rachel Ding

Use this template to capture the questions we should be asking when designing new code, systems, and features.

Status:
Draft
⁠
⁠

🗺 Context

Abstract

A one or two sentence summary of this design.

Background

Any context a reader will find useful when reviewing this design. Links to related docs, previous designs, wallows, etc.

Scope

What areas or subjects are in the scope of this effort? What is out of scope?

Requirements

What product requirements are driving the decisions made in this design? Might just be a link to a separate requirements doc, a table, or a bulleted list.

Reviewers & stewards 2

Reviewers & stewards 2

Person

Role

There are no rows in this table

⁠

🖌 High level design

This is where the meat of your design doc goes. Go nuts! Add more context. Use /image , /figma, /embed , or /file to add mockups, GIFs, Figma, videos, or other attachments below.

⁠

Alternative designs considered

Were any alternative designs considered? If so, what led you away from them? Invite others to upvote options. Use /callout and /reactions to add more option boxes and upvoting buttons below.

Alternative A

Statements and concerns about this option.

⁠

Alternative B

Statements and concerns about this option.

⁠

🧪 Testing

Unit Tests

What new components will be created and how will you test them?

Integration Tests

What new integration tests will be written as part of this design?

Visual Tests

Are new client side components part of this design? If so, how will you test those?

⁠

Done reading?
⁠
⁠

⁠

💬 Discussion

⁠

New topic

⁠

Discussed

Topic

Author

Upvote

Notes