News for hackers. Stuff that matters.
Re:Examples Are the Best Documentation by stronglikedan on Friday October 10, 2025 @02:48PM (#45542376)
To me, you're describing a specification, a type of documentation, with examples being another type. And I agree that a specification should just list definitions with explanations.

But there's no reason that a document cannot contain both a specification and examples. That's the type I prefer, and that's the type I mostly encounter nowadays. Usually a specification on the left with some examples on the right, maybe even interactive examples.

There are no comments on this comment yet.