Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge main to vercel_deploy (#14) #16

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Merge main to vercel_deploy (#14) #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bcf24b
Merge main to vercel_deploy (#14)
mygcho Nov 5, 2024
42cc302
Merge branch 'main' into vercel_deploy
mygcho Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/project-team/project-guidelines/part4-product-spec-learning-phase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---
Expand Down