Merge main to vercel_deploy (#14) (#16)

* Update part4-product-spec-learning-phase.md * updated readme * Update README.md * Update part4-product-spec-learning-phase.md Added Technical Design Doc Template for levels 2 & 3 teams, and updated descriptions for each. Changed the title to better fit the new templates. * Update part4-product-spec-learning-phase.md (#13) --------- Co-authored-by: Elijah Melton <[email protected]> Co-authored-by: Elijah Melton <[email protected]>
hcp-uw · Nov 5, 2024 · d835066 · d835066
1 parent a898d65
commit d835066
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md
@@ -16,6 +16,8 @@ This is an **extremely important phase of your project that should not be taken
 
 There are two different technical design docs/product spec templates we provide to you. Your team can discuss which spec would be ideal for your learning and preparation, but we recommend that level 1 teams use this **[Product Technical Spec Template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true)**, and that levels 2/3 use this **[Technical Design Doc Template](https://docs.google.com/document/d/1E9T0GCSYztEdXjgMYKJ06Pnkg4aySOzkGxQaabr3UbY/edit?usp=sharing)**. The only difference between the two is that the Technical Design Doc goes into more detail within your tech stack (High-level architecture, Databases, Models, Endpoints, Status Codes, etc.), so it may help your team answer more of the technical questions before you implement your project. It may be helpful to choose between one or another depending on the underlying knowledge between your teammates. Ask your club lead guide if you need guidance in choosing, or need example specs to read!
 
+Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=104753064155446271905&rtpof=true&sd=true)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions.
+
 When you finish a rough draft of your spec, let your club lead guide know so club leadership (our Design and Tech Teamns) can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work.
 
 ---