How can I write a great design doc?

Profile picture
Software Engineering Intern at Samsaraa year ago

I've been asked to write a design doc for my project; Samsara even has a structure to follow for these. After I understand how the overall system works, I will tackle. I want to make sure that there's a strong storytelling element in my doc, avoiding as much jargon as possible.

4 Likes
142 Views
1 Comment
👑

Discussion

(1 comment)
  • Alex Chiou
    Robinhood, Meta, Course Hero, PayPal
    a year ago
    • Keep it short: 2-3 pages should be fine. The bar shouldn't be too high for an intern - Don't let this doc "meta-work" distract you from the core intern goal of building strong coding ability.
    • Be concise. Use simple language and "ELI5" style explanations where you can.
    • Overall structure: Context/motivation (including a list of POCs) -> Proposed technical approach (with pros and cons) -> Consensus reached
    2 Likes