CodeNewbie cover image

S21:E3 - Why learning good documentation skills is so important for leveling up (Eddie Hinkle)

CodeNewbie

00:00

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.

Transcript
Play full episode

Remember Everything You Learn from Podcasts

Save insights instantly, chat with episodes, and build lasting knowledge - all powered by AI.
App store bannerPlay store banner