Week 7

Project: Ticket Tracking System

Sending emails

Design document

Technical interview

Back end Track

The API Design document

Before you write any code, you'll produce a short design document for your ticket tracking system. Designing first and getting it reviewed lets you catch schema and API mistakes while they're still easy to fix, instead of halfway through the project. It's also how design works on a real team.

Keep it simple. This should take about 1–2 days, not longer.

Document Template

Please use the following template for your API design document:

[https://docs.google.com/document/d/1teN5wY1rOhG9GGP4B2s_Zv0NOTnFBW7yJTtPbdaLC0k/edit?tab=t.0](https://docs.google.com/document/d/1teN5wY1rOhG9GGP4B2s_Zv0NOTnFBW7yJTtPbdaLC0k/preview?tab=t.0)

How to submit

  1. Open the template (Direct link) and make your own copy: File → Make a copy.
  2. Fill in every section.
  3. Share it with your mentor and wait for approval before you start coding.
  4. Once ready, export the document to PDF or Markdown and add it to your repository

The design document can be found in the following URL:

https://docs.google.com/document/d/1teN5wY1rOhG9GGP4B2s_Zv0NOTnFBW7yJTtPbdaLC0k

The HackYourFuture curriculum is licensed under CC BY-NC-SA 4.0 *https://hackyourfuture.net/*

CC BY-NC-SA 4.0 Icons

Built with ❤️ by the HackYourFuture community · Thank you, contributors

Found a mistake or have a suggestion? Let us know in the feedback form.