Vigyata.AI
Is this your channel?

How to Create a Technical Design Document (TDD)

22.2K views· 469 likes· 14:08· Aug 3, 2023

🛍️ Products Mentioned (1)

Learn how to create a technical design document using a Currency Converter Microservice as an example. Thank you Atlassian for sponsoring this video! Learn more about Jira and Confluence: ​​https://www.atlassian.com/software/confluence?blondiebytesutm_source=youtube&utm_medium=unpaid-social&utm_campaign=P:confluence*O:brand*F:awareness*C:video*W:knowledgewrkr*H:fy23q1*I:iacreators* Timestamps: 0:00-1:10 - Intro, What is a Technical Design Doc? 1:10 - 2:10 - Creating a confluence document and adding a TDD introduction 2:10 - 5:41 - Designing an architecture with draw.io marco 5:41 - 9:45 - Designing a spec with swagger macro 9:45 -11:15 Linking Jira stories 11:15 - 13:22 Reviewing our TDD and leaving feedback as comments 13:22 - 14:07 Summary

About This Video

Technical design documents (TDDs) are often how a technical initiative gets started at a company—and honestly, they’re the bread and butter for senior engineers. In this video, I walk through how I create a TDD using a Currency Converter Microservice example, and I build it in Confluence so it’s easy to collaborate, iterate, and keep everything in one place. I start with a simple intro section (why we even need this service), then move into an architecture overview that’s actually readable. From there, I design the architecture with a diagram (UI → API Gateway → currency converter microservice → exchange rate provider) and explain why we separate concerns: API Gateway handles auth/rate limiting/routing, the microservice owns the conversion logic, and the provider focuses on pulling exchange rates. I also add a Swagger spec right inside Confluence so other teams (like frontend) can consume the endpoints without guessing. Finally, I link Jira stories directly into the doc and show how I’d review a TDD by leaving targeted comments—like clarifying supported currencies and what “periodically updates” actually means. The big takeaway: planning up front makes implementation way less painful, and a collaborative TDD becomes your team’s single source of truth.

Frequently Asked Questions

🎬 More from blondiebytes