
In 2019, HubSpot’s developer docs had close to 500 pages, and poor usability and discoverability ranked #2 on our developer pain index. Endpoint design varied too.



With a content designer I split guides from endpoint reference and designed a new nav, page templates, and content modules. The docs shipped with CRM API v3, in preview in January 2020 and generally available in March.
How it was built

Upstream, I wrote a template for logging API usability problems and a set of API design best practices, and reviewed new public APIs before release.
New app developers had to assemble an OAuth install URL by hand. I made it build itself, and added an onboarding path with a sample. In an experiment, more developers made a first API call, in about half the time. More in The First Mile.
The full version, with the numbers, is on a private page. Ask me for access.