into v2 (pain points, quality of integration) • Aim for improvements to experience, rather than “step change” • Release when it’s ready • Client libraries from OpenAPI
API v3, before we actually make it, and ask for feedback?” Evolution of idea: “Let’s stagger our ‘ideal’ changes to the API in a docs instance, and ask for feedback.”
crossover) Alan Carrie, software engineer: API v3 development, reviewing and working on docs Ben Ahmady, tech writer: Documentation + setup of instance, OpenAPI, Postman collection
changes • Establish docs instance workflow • Open docs up for feedback (in “time windows”) • Make changes to the API itself after feedback windows close
almost immediately to internal domain 3. Advertise the ‘Review apps’ deployment on Slack 4. Ask for feedback 5. Scrum: make changes (API, OpenAPI spec, Postman collection) 6. Repeat
new joiners - so far • Focused on usability of v3 • Docs are important, but some prefer Postman nearly entirely (justifying additional focus) • Some very obvious fixes to make to improve testing