Making Your Code Examples Shine
summary
Claims that code examples are auto-generated and manually generated using a Go utility generate-code-examples, that Stripe maintains a style guide and per-language templates, and that the API ref renders eight languages for five charge methods producing about forty examples per charge and nearly 300 contextual docs. Runnable examples use RunKit, tests run against stripe-mock, and linters validate syntax. The automation reduces toil but requires overrides and careful syncing to avoid inconsistencies.
AI-written summary · about
chapters (12)
- 0:00Start
- 7:30Research Your Audience
- 8:40Establish What You'll Support
- 10:36Envision Enhancements
- 15:13Treat Your Code Like Your Writing
- 17:52Communicate Through Your Code
- 19:41Provide Feedback to Your Engineers
- 20:32Making Your Code Examples Shine
- 21:17Automate Within Reason
- 23:31Generate Code Examples Programmatically
- 25:20Run and Automate Tests - Testing against your libraries and API
- 26:25Avoid Pitfalls
related talks
30mArtisanal, machine-generated API libraries
32mBoutique machine generated gems
32mHow we build APIs and Team at Stripe
40mNeed Examples? Write Your Own!
46mDocumentation That Runs: Bridging Code, Prose, and Interactivity
32mDesigning for developers
42mDocumentation as an application: enabling interactive content tailored to the user
30mWrite Less (Code), Generate More