Need Examples? Write Your Own!
summary
Demonstrates concrete steps: creates a style guide for code examples, uses raw customer curl snippets and edits them into readable curl examples, and proves the sequence works by testing each step. Implements a real Pet Store Plus REST API flow: get an auth token, add a store, add a pet — a three-step process tied together with short guided learning paragraphs. Emphasizes prioritizing examples from support and engineers and avoiding untested copy‑paste code.
AI-written summary · about
chapters (32)
- 0:00Start
- 0:25My Background
- 1:06Learning Objectives
- 2:04More reasons for examples
- 3:23You're Not An Imposter
- 4:00Context
- 4:40Use doc skills in planning
- 5:37Listen to needs
- 6:36Prioritize needs
- 9:52Follow the steps
- 10:14The API - Petstore Plus
- 10:59Listen (revisited)
- 11:31Needs (revisited)
- 12:15Prioritize (revisited)
- 12:45Gather (revisited)
- 13:31Style Guide (revisited)
- 15:02Plan summary
- 15:35Adding Pets to a New Store
- 16:19Raw CURL command - Get Token
- 18:07Add Store - Curl Command Style Edit
- 19:24Add Store Data Style Edit
- 20:48Add Pet to Store - CURL Command Style Edit
- 21:02Add Pet Data Style Edit
- 21:15In Summary
- 21:41Test
- 22:47Authentication
- 23:553. Add a Pet (continued)
- 24:05Guided Learning Result
- 26:02My Implementation
- 26:25Writing Good Code examples
- 27:09Remember
- 27:28Additional Resources
related talks
46mUnit Testing by Example
28mMaking Your Code Examples Shine
46mDocumentation That Runs: Bridging Code, Prose, and Interactivity
49mExplain Yourself! Documentation for Better Code
35mDev Experience in Technical Writing: 15 Tips to Boost Developer Satisfaction
26mTips and tricks for writing API Tests
27mGetting developers hooked on your API
18mFive Essential Design Assets for Successful APIs