Writing great "getting started" documentation

on YouTube ↗28m

" summary

A payments API company with a team of four builds a linear getting-started guide that lives beside the Swagger reference, integrates with the dashboard, and reduces the same basic questions asked weekly. Key choices: embedded API keys in code samples so users can copy‑paste, linear getting-started guide with dashboard steps that lead to the product’s magic moment, usability tested on real beginners, and automated checks to prevent broken examples.

AI-written summary · about

" chapters (7)

1. 0:00Introduction
2. 2:02API Documentation
3. 4:40Who is your audience
4. 7:50The magic moment
5. 9:23Getting started documentation
6. 12:22Integration
7. 15:46Key Concepts

" related talks

• 24mDocs for Developers: How to start when everything is hardHeidi Waterhouse · apidays Paris 2021
• 19mStreamlining API Documentation: Proven DocOps StrategiesKateryna Osadchenko · apidays London 2023
• 27mGetting developers hooked on your APINicolas Garnier · Codemotion Amsterdam 2016
• 24mHow to make your API Platform easy for Developers to AdoptDerric Gilling · apidays New York 2020
• 27mBoost Your API with Effective Documentation StrategiesAsh Arnwine · apidays New York 2023
• 21mIntroducing The API LifecycleAndreas Krohn · Nordic APIs World Tour 2015
• 38mZen And The Art Of Automanually Creating API Documentation - An Inquiry Into ProcessDan Grabski · Write the Docs Portland 2023
• 26mA sensible API Document Management guideVanjikumaran Sivajothy · Apidays LIVE Paris 2020