Weeks 4 and 5: three paragraphs, a full page Β· about 20 minutes
A design doc is a short paper that explains what you plan to build and why, before you build it. Writing it forces you to think, and it lets others find problems while they are still cheap to fix.
Start with the problem, not the solution. Who is hurting, and how do you know? Add one or two numbers. Then state the goals and, just as important, the non-goals: the things you will not try to solve. Non-goals stop the project from growing forever.
Next, describe your design with a simple diagram. Then list the other options you considered and why you did not pick them. Reviewers trust a doc more when they see you looked at alternatives. End with the risks and open questions. A good design doc is not a sales pitch. It is an honest map.
How. Read one sentence. Look up. Say it in your own words. Then go on. Keys: β next, β back, Esc to show all.
To think clearly and let others find problems while they are cheap to fix.
Things the project will not try to solve.
βοΈ Homophones: their, there, they're
their = belongs to them. there = a place. they're = they are.
Watch out. it's = it is. its = belongs to it. "The team shipped its feature."
Test yourself. The words hide. You hear a word, then type it.
π The word "the": thuh or thee
Say thuh before a consonant sound: the plan. Say thee before a vowel sound: the end.
How. Press π, then say it 3 times. Record yourself on your phone and compare.
Say each word out loud. Then make your own sentence with it.
design doc
say: dih-ZYN DOK
a paper that explains a plan before building
βPlease review my design doc.β
non-goal
say: NON-gohl
something a project will not try to do
βMobile support is a non-goal.β
alternative
say: awl-TER-nuh-tiv
another possible choice
βWhat alternatives did you consider?β
diagram
say: DY-uh-gram
a simple drawing that explains something
βAdd a diagram of the flow.β
honest
say: ON-ist
telling the truth
βBe honest about the risks.β