devz-docz

Aggregation of onboarding and general devz standards that I have gatherd over my career.

View on GitHub

Title

Overview

In one or two sentences, summarize what the problem is and how you intend on solving it. It’s helpful to outline the stakeholders here, as it informs why this problem merits solving.

Background

This section is for going into more detail about the problem.

At least one example should be used to help the audience understand the context better.

Proposed Solution

Detail your solution here. Start with a broad overview and then go into detail on each portion of the design.

Visual representations of the solution can be helpful here (ex. a diagram for a request lifecycle).

Implementation

Without going too much into individual tasks, write an overview of what this solution’s implementation would look like.

Trade-offs

Cross Team Dependencies

If there are multiple teams or clients that are dependencies for implementation to be successful, list them here. Examples of this are security or design collaboration/reviews.

Further Reading

List any resources you found helpful to make this design.