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
How to write a great documentation? 1. How to format? Use question and answer format (FAQs) 2. Use pointers wherever possible a. maximum 5 and preferably 3 b. if it goes beyond 5, use sub-points 3. Diagrams and examples wherever possible. an image 🖼 is worth a 1000 words 4. Be precise, accurate, use w h i t e s p a c e s 5. Avoid similar synonyms, generous adjectives, spellnig and an grammatical mistakes a. repeat same words used to refer same words b. Have internal links pointing to definitions c. Avoid external links, instead provide a brief (reduces distraction). Add external links only for confidence Add your ideas below
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.
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.
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
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.
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.
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.
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.
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.
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
![Noob To Max With DRAGON REWORK In Blox Fruits [FULL MOVIE]](http://i.ytimg.com/vi/LnBMOinoOvA/mqdefault.jpg)
This is a critical and great video for people to watch to improve themselves, not even necessarily coding related
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
Man, you are so good, 100% agree each word. Especially about the speakers that go straight in-depths since 0th min on their presentation
How to write a great documentation?
1. How to format? Use question and answer format (FAQs)
2. Use pointers wherever possible
a. maximum 5 and preferably 3
b. if it goes beyond 5, use sub-points
3. Diagrams and examples wherever possible. an image 🖼 is worth a 1000 words
4. Be precise, accurate, use w h i t e s p a c e s
5. Avoid similar synonyms, generous adjectives, spellnig and an grammatical mistakes
a. repeat same words used to refer same words
b. Have internal links pointing to definitions
c. Avoid external links, instead provide a brief (reduces distraction). Add external links only for confidence
Add your ideas below
and a thing everyone forgets: write what the thing even is. This part is missing in pretty much all design docs.
I would recommend put examples
@@andrewmosplus the above documentation itself is an example
@@ngneerin Not an example for your "documentation", I said in general, put examples for every documentation
This type of content is really interesting to watch 😁
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 😂
I love your passionate eloquence ❤🔥
20 pages is long? Don’t work for the government, that’s just the intro.
This is pretty good tip! Thanks for sharing this!
You don't get negative comments because your videos are perfect 😉
what an amazing video ! thank you it was helpful
Navdeep learnt how to clickbait people. haha that thumbnail got me. But glad I clicked tho. good content
was he his tech lead?
@@dao-lamhe said his tech lead was smart, make of that what you want 😂
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.
Apart from career wise, it just makes the industry so much better if people do this more
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.
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 /:
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.
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
I would love to see a before and after after design doc video
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.
1. Amazing examples and insight. 2. But was your tech lead the actual Tech Lead??
The crossover we didn't know we needed
Thank you. You are the best
Take this as a medallic symbol of hope, indeed.
1:46 one could say he was lubing it up before he went in.
Keep doing more of these videos
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.
for a sec i thought techlead roasted you
But was that THE tech lead?
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.
Unfortunate clickbait preview
Yup
Great vid
7:00 You need to indent your lists, it's easier to read.
Plug it, we here for that ....
No way TechLead(at google and facebook) is so wholesome!
ChatGPT writes my design docs
Now I know why Google API documentation is so crappy. Googler's don't step on each others toes.
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.
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.
basically KISS
What a great video
hey, any thoughts on making a competitive programming question series? that would be really helpful.
Me a director at big tech got appreciated for 50 page design doc.
Use bard to clean it up
What is the point of a design doc if no one will really read it?
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.
Very helpful 👌🏻👌🏻
Could you bring Konrad back to roast this design on cam?
dude didn't you have chatgpt back then?
Why is this other guy there on the thumbnail?
How many more clips do u have 😂😂😂😂
Yes.
Good info
smart guy.
Was he the tech lead in your group for real ?
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
This design doc you showed doesn't do anything.
It just lists a bunch of services other people wrote.
Programming is not about this.
I clicked this thinking it is real design problems and solution criticism. 😅.
so why not make videos about how to write good design documents ? I would like to pay for that😂🎉🎉
@Neetcode
Please share your equipment. I like your voice a lot.
Maybe because of your mic.😁
I’m from Florida. I know what a pub sub is
AWS be like: 😬
kinda got baited by the thumbnail...
Anyone else thinks he is talking faster than usual?
Where are all these clips from, it looks from live streams but I cant find those live streams in your youtube
You're looking on the wrong channel
I'm looking for a tech lead - a super interesting Fintech opportunity.
noice
easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy easy homie
Geeks, bruv
fn' git gud then