Category / documentation dx
Documentation & DX
Teardowns and rewrites of docs, quickstarts, SDKs, and developer journeys.
Designing an API Reference Developers Actually Read: Examples, Errors, and Auth Up Front
An API reference is read under pressure, mid-debug. Design it that way: auth before endpoints, a worked example per operation, and errors documented like features.
Changelogs Are Product Writing: Entries Users Read and Releases That Earn Trust
Why the changelog is product writing, not a commit digest, and how to write entries that users actually read and act on.
Auditing a Developer Onboarding Funnel: Signup to First API Call, Timed and Scored
A repeatable audit method for the developer onboarding funnel, with a scoring rubric and a clearly labelled illustrative walkthrough.
Diátaxis, Applied: Reorganising a Real Docs Site Without a Six-Month Rewrite
A field guide to applying the Diátaxis framework incrementally: audit what you have, split the pages that do two jobs, and move content in slices readers never notice.
Docs as Code, With Teeth: Linting, Link Checks, and Preview Builds in CI
Wire documentation into CI so quality is enforced, not hoped for: prose linting that respects writers, link checking without false alarms, and previews on every pull request.
Error Messages Are Documentation: A Field Guide to Writing Failures Users Can Fix
A practical method for writing error messages that name the problem, state the cause, and hand the user a fix they can actually perform.
Rewriting a Quickstart Live: From Feature Tour to First Success in Five Steps
A step-by-step rewrite method that turns a feature-tour quickstart into a task-first guide ending in a verifiable first success.
The README Is Your Landing Page: Structure for Open-Source Projects That Want Contributors
How to structure a README that converts a curious visitor into a running install, then into a first contribution.
Docs Teardown: Twilio's Quickstart Funnel and the Art of the Five-Minute Win
How Twilio's quickstarts are engineered as a funnel: pre-written code, a working result in minutes, and a deliberate handoff from first success to production depth.
Docs Teardown: What Vercel's Documentation Gets Right About Developer Journeys
A teardown of Vercel's docs: how task-based navigation, framework-aware content, and honest limits pages turn a platform manual into a guided developer journey.
Paystack vs Flutterwave vs Stripe: Whose API Docs Give You the Clearest Path to a First Payment?
A documentation teardown of Paystack, Flutterwave v4, and Stripe for Nigerian developers—from test keys to server verification and a working webhook.
No matches in this set.
Clear a filter or try another combination.