Discover the art of crafting effective developer documentation in this 23-minute PyCon US talk by Meredydd Luff. Learn why documentation is crucial for the success of your library, framework, or API, serving as content marketing, product definition, and user interface. Explore different types of documentation, including API and reference docs, and understand their distinct purposes. Gain insights on viewing documentation as a user journey and the importance of user feedback. Delve into strategies for creating clear, informative, and user-friendly documentation that enhances developer adoption and usage of your product. Access accompanying slides for visual reference and reinforcement of key concepts presented in this informative talk on writing good documentation for developers.
Overview
Syllabus
Intro
Writing Good Developer Docs
Why do we care?
Docs are content marketing.
Docs define your product.
Docs are your user interface.
Types of Documentation
API docs are not reference docs.
Reference docs tell a story.
API docs describe code objects.
Your user is on a journey.
Talk to your users
Questions are bug reports.
Answers are patches.
Explanation
Taught by
PyCon US
