Tag
documentation
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.
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.
No matches in this set.
Clear a filter or try another combination.