The link between technical documentation and developer engagement
summary
A recent survey finds 27.79% use video while 56.82% do not and 13.65% plan to add multimedia, so the concrete claim is that video/screencasts are rare in API docs. Recommended tactics: embed short API demos (example: a two‑minute Google Pay integration walkthrough), include use cases and code snippets, and treat wikis as too vague—create dedicated docs. Tools cited for REST APIs are Postman and Swagger. Main friction: extracting accurate details from busy engineers.
AI-written summary · about
chapters (20)
- 0:00Introduction
- 1:18Presentation Outline
- 1:52Survey
- 2:29Agenda
- 2:52Why accommodate multimedia content
- 3:20Number of developers using Apis
- 4:38User Documentation vs Developer Documentation
- 5:59Developer Documentation
- 6:49API Demo
- 8:02Developer Relations
- 8:37Developer Relations Responsibilities
- 9:58Developer Education
- 11:30Key takeaways
- 13:07Technical vs User Documentation
- 14:26Developer Documentation Specialist
- 17:05Documentation in a wiki format
- 18:20Which tool is good for creating documentation
- 19:35What is the role of data sheets
- 20:26What is the most challenging aspect when writing technical documentation
- 22:10Closing remarks
related talks
27mGetting developers hooked on your API
35mDev Experience in Technical Writing: 15 Tips to Boost Developer Satisfaction
41mREST API documentation
35mDocumenting APIs: new era, same craft
30mSo You Need to Document an API?
22mBeyond the Spec: Making OpenAPI More Human
35mOpenAPI for Documentarians
25mDo you know who's reading your Docs?