Skip to content

Comment on Ask HN: What is the best product documentation you’ve ever seen?

Comments

https://docs.airship.com/

Airship, formerly Urban Airship, i think.

a few years ago i was helped to build out a Sphinx-based search feature, integrate it into a Pyramid-based app, and something UA were doing made me want my app/docs to look/act like theirs

part of it was the search, part of it was the comprehensiveness, part of it was the magically-appearing in-page #anchor links when you'd mouseover an <H>-type header element so that you could easily refer to a section of a page -- something which i feel like is obviously crucial to useable docs, but rarely exists in real life, and part aeshetics.

a quick glance just now seems they still have docs, tho i guess most established company doc sites would look good and generally be high-functioning these days. i suspect more of them were built from scratch back in the day, but not sure -- it's prob difficult for the docs vendors to keep up with integrating api tools, etc.

AboutSource Built by g1lg1l

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