Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

Hypertext to the rescue! Here's the lede sentence:

> In [Structured Query Language (SQL)](https://example.com/sql/), you can solve Unusual Complicated Problem with Super Advanced Thing.

That said, one time I had in mind a reader archetype, for whom I added an appendix of one basic concept, which ideally they'd already know, but likely didn't.

<https://docs.racket-lang.org/roomba/index.html#%28part._.Ass...>

I could've linked the some mentions of "association list" to a chapter of some textbook they'd never seen before-- and maybe they would read it, and maybe they would come back.

But instead, I decided to give a quick overview, in terms of an example relevant to what I was documenting, and leave them with a code pattern they could use, to get on with programming a robot like they came to my document to do.

(Though I wish I'd put an accessible showing-off demo example near the beginning of the document. After the intro, it reads a little too much like the glorified inline API docs that it is.)

 help



Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: