Hacker News new | ask | show | jobs
by bryanlarsen 339 days ago
> What makes the documentation good isn’t, however, related to people’s ability to navigate information spaces.

Then what's the point? If nobody can use the documentation properly, then the term "good documentation" is meaningless.

1 comments

I think the article is saying that good documentation is objective, and is not defined by ease of use. You will ingest this difficult documentation and you will like it, because it is good for you.

You might reasonably ask "in what way".

> this is how documentation is, because this arrangement is part of its integrity, and this is how you must learn to use it and work with it.

The word "integrity" comes up six times. Something about integrity.

Yeah, this isn't something you put your name on. It's something the company pays you to do, to make the product better. Good documentation significantly improves a product. Which means making that information accessible to web natives.

Luckily, unlike web natives, LLM's have read lots of documentation cover to cover. Likely a good way to teach LLM's about your product is to write good documentation.