Writing Good Documentation for Developers

Writing Good Documentation for Developers

PyCon US via YouTube Direct link

Docs are your user interface.

6 of 15

6 of 15

Docs are your user interface.

Class Central Classrooms beta

YouTube playlists curated by Class Central.

Classroom Contents

Writing Good Documentation for Developers

Automatically move to the next video in the Classroom when playback concludes

  1. 1 Intro
  2. 2 Writing Good Developer Docs
  3. 3 Why do we care?
  4. 4 Docs are content marketing.
  5. 5 Docs define your product.
  6. 6 Docs are your user interface.
  7. 7 Types of Documentation
  8. 8 API docs are not reference docs.
  9. 9 Reference docs tell a story.
  10. 10 API docs describe code objects.
  11. 11 Your user is on a journey.
  12. 12 Talk to your users
  13. 13 Questions are bug reports.
  14. 14 Answers are patches.
  15. 15 Explanation

Never Stop Learning.

Get personalized course recommendations, track subjects and courses with reminders, and more.

Someone learning on their laptop while sitting on the floor.