Artwork

Content provided by Working as Designed Podcast. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Working as Designed Podcast or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Player FM - Podcast App
Go offline with the Player FM app!

Code Documentation is Useless

8:58
 
Share
 

Manage episode 387016544 series 3491279
Content provided by Working as Designed Podcast. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Working as Designed Podcast or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

It's easy to write what the code is doing, but does that really help? Let's talk about the WHY documentation can be useful and HOW to avoid the pitfalls.

What kind of documentation has been helpful to you?

#podcast #software #coding #webdevelopment #development #career #advice #documentation #api #restapi #sandcastles

0:00 - Intro
0:18 - Cognitive Load
1:20 - What's a bad comment
2:14 - What make's a good comment
3:40 - Documenting Rest API
8:13 - What's better? No Documentation or Heavy Documentation
8:50 - Outro

  continue reading

39 episodes

Artwork
iconShare
 
Manage episode 387016544 series 3491279
Content provided by Working as Designed Podcast. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by Working as Designed Podcast or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

It's easy to write what the code is doing, but does that really help? Let's talk about the WHY documentation can be useful and HOW to avoid the pitfalls.

What kind of documentation has been helpful to you?

#podcast #software #coding #webdevelopment #development #career #advice #documentation #api #restapi #sandcastles

0:00 - Intro
0:18 - Cognitive Load
1:20 - What's a bad comment
2:14 - What make's a good comment
3:40 - Documenting Rest API
8:13 - What's better? No Documentation or Heavy Documentation
8:50 - Outro

  continue reading

39 episodes

All episodes

×
 
Loading …

Welcome to Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

 

Quick Reference Guide