# tech-designs

DEPRECATED - Tech Designs were once . They have now been replaced

## Tech Designs

If you are planning on writing a tech design, make sure to familiarize yourself with our [general guidelines](https://docs.google.com/document/d/1sMO9piTYhzBH08FUYycOWMku90X0DR2EutF7qa_36-A/) and use our [dedicated template](https://docs.google.com/document/d/1zcxXlpRHQ47yZWWqkTbGKUCd4BWwBzZMjeINK4SsFvA/). If you have issues accessing any of the Google Docs listed below, please ask for permission.

When working on a Tech Design please make sure to add it to the [Orchard Tech Design Master List](https://docs.google.com/spreadsheets/d/1KfHk7uCcxscTkXZKMdHWKar0v9TjOgae3GepHRKsX00/edit#gid=0). This list is useful both to keep track of what Tech Designs need to be reviewed as well as provide a historical context for the general direction of our tech architecture. Once the TD has been approved, don't forget to update its status and Approval Date in the Master List.

### Questions:

### _PANIC! I don't even know where to start!_

Check out these [helpful tips on the Tech Design writing process](https://docs.google.com/document/d/1WfpjGXJK8fmnWxO40oRzRCZDvE-_wBjyNx0rSE_e9Nw/edit)!

**Who should review my Tech Design?**

At least one architect and one team member of the author's squad should be included as Reviewers. Any related squads impacted by the changes in a Tech Design should also have a team member included. When in doubt, ask your Director / the `#architecture` Slack channel for advice.

**How Do I circulate my Tech Design for approval?**

1. Reach out to reviewers directly \(either via email or Slack\) so they know their feedback is needed.
2. Post a message in the `#tech-design` Slack channel with a link to the Tech Design in order to keep the entire Orchard engineering team in the loop.
3. Add a ticket to the [AR Backlog Jira Board](https://jira.theorchard.com/secure/RapidBoard.jspa?rapidView=237) tagged with the 'Tech Design Review' Epic Link and marked as 'Ready for Dev' so Architects can prioritize reviewing it.  
4. Add the Tech Design to the [Orchard Tech Design Master List](https://docs.google.com/spreadsheets/d/1KfHk7uCcxscTkXZKMdHWKar0v9TjOgae3GepHRKsX00/edit#gid=0) so it is easy to find.

**I Have an Informal / Internal Team-only Tech Design, Should I add it to the Tech Design Master List?**

Whether the TD is formal or not, if the authors of the document feel there’s information in it that could be useful to other engineers, feel free to add it to the list with a status of 'Internal Only'. That said, ultimately it’s the decision of the group writing an 'Internal Only' TD as to whether they want to add it to the list.