How to write a great documentation (in 5 points) 1. Use question and answer look (more like FAQs) 2. Use pointers wherever possible a. maximum 5, preferably 3 b. if goes beyond 5, try making sub-points instead 3. Diagrams wherever possible. a 🖼 is worth a 1000 words 4. Be precise, but accurate. And have w h i t e s p a c e s , increases readability. 5. Avoid similar synonyms, generous adjectives, spellnig and grammatical the mistakes a. repeat same words already used to refer something b. have links to go to something previously explained c. Avoid external links, instead provide a brief. Add link only for confidence (reduces distraction) Add if you know something that I am missing
@vornamenachname5947 ай бұрын
and a thing everyone forgets: write what the thing even is. This part is missing in pretty much all design docs.
@yang584311 ай бұрын
This is a critical and great video for people to watch to improve themselves, not even necessarily coding related
@RyanShappa11 ай бұрын
Neetcode, you helped me get a job a year ago and now you're helping me get promoted with this video. I think another channel or other videos on how to get promoted would be so awesome! Thank you as always neetcode
@for_whom_the_bell_tolls10 ай бұрын
Man, you are so good, 100% agree each word. Especially about the speakers that go straight in-depths since 0th min on their presentation
@woltzwurld67609 ай бұрын
20 pages is long? Don’t work for the government, that’s just the intro.
@ericm9710 ай бұрын
Unfortunate clickbait preview
@kabirkumar58153 ай бұрын
Yup
@muhammadazeembinrosli380610 ай бұрын
I remember during college, I didn't even know what to write in my documentation/report but it was like a competition to write a book back then 😂
@tzuilee58811 ай бұрын
This type of content is really interesting to watch 😁
@ks0ni11 ай бұрын
You don't get negative comments because your videos are perfect 😉
@Iammrunkown9 ай бұрын
My product manager roasts me for not being able to finish up date pickers in a day. "You're taking too much time" - my product manager.
@patriciogarcia54428 ай бұрын
I love your passionate eloquence ❤🔥
@ggpeebles10 ай бұрын
1. Amazing examples and insight. 2. But was your tech lead the actual Tech Lead??
@aznstride432511 ай бұрын
Ah crap. I didn’t like writing design docs in Amazon, so I was hoping to go to Google. Turns out they write even more docs /:
@manchuratt890011 ай бұрын
1:46 one could say he was lubing it up before he went in.
@avrukin11 ай бұрын
You never attended my swe onboarding class 😀. I had a slide dedicated to “you better learn to write real fast AND carve out lots of time to read” and I would pause, elaborate, AND show 3 different design document examples.
@Pravasith11 ай бұрын
Navdeep learnt how to clickbait people. haha that thumbnail got me. But glad I clicked tho. good content
@dao-lam10 ай бұрын
was he his tech lead?
@SuperCaptain410 ай бұрын
@@dao-lamhe said his tech lead was smart, make of that what you want 😂
@Jay-qm4zd10 ай бұрын
ChatGPT writes my design docs
@chiefs2ndbase11 ай бұрын
Although I’m late to this, it is interesting to see this video. My current degree required a “professional writing” course which discussed how to effectively write technical information in a means that is visually readable (layout of page) and concise/to the point. The other interesting topic was “plain English” in how it breaks things down to be accessible to all audiences no matter their technical knowledge. It’s fascinating to see the one “English” class Ive enjoyed in college be applicable
@miniyy1611 ай бұрын
I have been following your channel for a long time, since covid. After watching your dropping out of Amazon video, you became my inspiration. I hope I get to write my story as yours. Thankyou for your content.
@codekundan11 ай бұрын
Such a great video if anyone wants to improve his/her career in Software Industry. Very few people tell this. Generally I learned it through experience.
@kabirkumar58153 ай бұрын
Apart from career wise, it just makes the industry so much better if people do this more
@kaioneal616011 ай бұрын
I would love to see a before and after after design doc video
@destinysora280711 ай бұрын
Take this as a medallic symbol of hope, indeed.
@assisinoАй бұрын
The crossover we didn't know we needed
@pavel.pavlov11 ай бұрын
But was that THE tech lead?
@Shuyinz10 ай бұрын
This is pretty good tip! Thanks for sharing this!
@yassinebenazouz452911 ай бұрын
what an amazing video ! thank you it was helpful
@sumitsharma673811 ай бұрын
How many more clips do u have 😂😂😂😂
@BrainRainGoAway11 ай бұрын
Yes.
@sphesihlemanuel29332 ай бұрын
Plug it, we here for that ....
@muhammadxojarustamxojayev767811 ай бұрын
Thank you. You are the best
@tommyshelby627711 ай бұрын
for a sec i thought techlead roasted you
@vicks7113 ай бұрын
Now I know why Google API documentation is so crappy. Googler's don't step on each others toes.
@amogus1337-tw7wc8 ай бұрын
No way TechLead(at google and facebook) is so wholesome!
@FungoTechАй бұрын
I always prefer to get honest feedback than being always pat on the shoulder especially when one has impostor syndrome because with an honest feedback we can smooth rough corners.
@rodrigomarchi975511 ай бұрын
Great vid
@jagicyooo200711 ай бұрын
basically KISS
@Fanaro10 ай бұрын
7:00 You need to indent your lists, it's easier to read.
@sergrojGrayFace9 ай бұрын
Writing a design doc probably takes like half the time that writing code to do the design does on average. Some people are good at it, but for some programmers writing docs is pure torture.
@HoD999xАй бұрын
i never had to write a design doc in 20 years. i think they are useless unless you have *many* readers and the design won't change next week.
@yogsothoth003 ай бұрын
Then there's the question - do I need to keep the design doc up to date when everything changes after the first iteration? Nobody is reading it anymore, seems like a waste of time.
@va11bhav_rana11 ай бұрын
hey, any thoughts on making a competitive programming question series? that would be really helpful.
@aben6211 ай бұрын
Because you have been successful enough so that by criticizing you can bring attentions. As for that guy claim himself as a techlead, please ignore that clown
@lautarocolazo493811 ай бұрын
Keep doing more of these videos
@no3lcodes10 ай бұрын
What a great video
@nikhil19902926 күн бұрын
Me a director at big tech got appreciated for 50 page design doc.
@kmg87719 ай бұрын
Use bard to clean it up
@anantom25111 ай бұрын
@Neetcode Please share your equipment. I like your voice a lot. Maybe because of your mic.😁
@abovebelow40619 ай бұрын
kinda got baited by the thumbnail...
@EstebanWong889 ай бұрын
Could you bring Konrad back to roast this design on cam?
@ayeminoo206711 ай бұрын
I clicked this thinking it is real design problems and solution criticism. 😅.
@trueroughly16919 ай бұрын
smart guy.
@user-ov5nd1fb7s8 ай бұрын
This design doc you showed doesn't do anything. It just lists a bunch of services other people wrote. Programming is not about this.
@user-wr4yl7tx3w10 ай бұрын
What is the point of a design doc if no one will really read it?
@AlexanderNecheff9 ай бұрын
Serves as a project road map. Provides an anchor for controlling scope. Is an onboarding tool for new team members. Helps you think through the design and test some of your assumptions. Leaves a record of not only what was done but why it was done for future maintenance teams.
@zhangxinhello11 ай бұрын
so why not make videos about how to write good design documents ? I would like to pay for that😂🎉🎉
@keldur1610 ай бұрын
I’m from Florida. I know what a pub sub is
@jackbotman8 ай бұрын
Good info
@rosendo3219Ай бұрын
dude didn't you have chatgpt back then?
@penggao227811 ай бұрын
Anyone else thinks he is talking faster than usual?
@fatalsg92Ай бұрын
AWS be like: 😬
@vaisakhkusabhadran422210 ай бұрын
Why is this other guy there on the thumbnail?
@markrussellfilaroski503511 ай бұрын
I'm looking for a tech lead - a super interesting Fintech opportunity.
@khushalvyas563311 ай бұрын
Very helpful 👌🏻👌🏻
@arkajyotisaha606110 ай бұрын
Was he the tech lead in your group for real ?
@rey363511 ай бұрын
Where are all these clips from, it looks from live streams but I cant find those live streams in your youtube