Skip to content

Designing Docs for Developers

trigger.io
59 pointsamirnathoo3 comments
On HN

Comments

nice top-level categories. Too many doc pages can't even correctly do something that simple.

One thing I hate is fixed headers. If I'm scrolling down the page, I want to read whats on the page, not have you shove your branding down my throat while also reducing the amount of content on my screen. If your stuff is good, i'll happily scroll up and click on your stuff, but don't force it on me (this is a problem with blogs too).

I'd be satisfied if most documentation looked more like stripe's: https://stripe.com/docs/api

That was... perfect.

-> You send us X

<- We give you Y

Why is it so many api docs fail on this basic level?

AboutSource Built by g1lg1l

Hackerly is an independent reader for Hacker News, built on the public HN API. Not affiliated with Y Combinator.