Skip to content

Instantly share code, notes, and snippets.

@xavxyz
Created August 26, 2020 09:33
Show Gist options
  • Save xavxyz/ad6a68bf7c1928acbc11a05015d80f7e to your computer and use it in GitHub Desktop.
Save xavxyz/ad6a68bf7c1928acbc11a05015d80f7e to your computer and use it in GitHub Desktop.
name about title labels assignees
Design Document
Why we should work on this, what this is about, how we will build this.
design doc

Why?

The thing that should provide value to the business or the tech.

But there is a problem.

And maybe another one.

Features

  1. Abc
  2. Xyz
  3. Pipo

Feature 1 — Abc

  • ...

Feature 2 — Xyz

  • ...

Feature 3 — Pipo

  • ...

Deployments

  • ...

Tests

  • Unit tests (/commons):
    • ...
  • Integration tests (/commons):
    • ...
  • Integration tests (/tyrion):
    • ...
  • Integration tests (/cersei):
    • ...
  • Integration tests (/john):
    • ...
  • E2E tests run (/cersei):
    • ...
  • E2E tests run (/john):
    • ...

Tradeoffs

  • ...

Dates

Features Expected Staging Staging Deployment Expected Production Production Deployment
1 2020-mm-dd → 2020-mm-dd 2020-mm-dd 2020-mm-dd 2020-mm-dd
2 2020-mm-dd → 2020-mm-dd 2020-mm-dd 2020-mm-dd 2020-mm-dd
3 2020-mm-dd → 2020-mm-dd 2020-mm-dd 2020-mm-dd 2020-mm-dd

Next steps

  • ...
  • ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment