AI-powered
podcast player
Listen to all your favourite podcasts with AI-powered features
1min chapter
S21:E3 - Why learning good documentation skills is so important for leveling up (Eddie Hinkle)
CodeNewbie
What Makes Good Documentation and What Doesn't?
Bad documentation is explaining things that people may already know. It may be explaining things in a way that isn't applicable to the person reading it. So understanding who your audience for this documentation is for is definitely a key aspect. If you're a back end developer and you are writingapi documentation, but you explain it away a back end developers would understand it,. then the front end developers will have a hard time.
00:00
Transcript
Episode notes
Get the Snipd
podcast app
Unlock the knowledge in podcasts with the podcast player of the future.
AI-powered
Discover
highlights
Listen to the best highlights from the podcasts you love and dive into the full episode
Save any
moment
Hear something you like? Tap your headphones to save it with AI-generated key takeaways
Share
& Export
Send highlights to Twitter, WhatsApp or export them to Notion, Readwise & more
AI-powered
podcast player
Listen to all your favourite podcasts with AI-powered features
Discover
highlights
Listen to the best highlights from the podcasts you love and dive into the full episode