[ChrisMarshallNY]

My biggest peeve, is bad indexing.

The docs are there. The information is there, but finding it, is so difficult, that I have often just said "bugger this for a lark," and written my own implementation.

There's two types of docs: The teaching kind, as the article mentions, and the reference kind, for helping folks that already have a start, to find what they need.

I generally do the second. It can be fairly easily generated from inline headerdoc comments, these days, but we still have the issue of indexing, and I still have my work cut out for me, there.

Here's some stuff I wrote about my approach to documentation: https://littlegreenviper.com/leaving-a-legacy/

[Sparkyte]

Absolutely this! If I have to use a search box to find docs and not the navigation pane you know you're doing something wrong with your docs.

[ChrisMarshallNY]

I’m hoping that LLMs may be helpful, here. Sort of like a “documentation concierge” service. Like going to the reference desk in a local library, and asking The Librarian to help you find some information.

[Sparkyte]

I believe so. I am also hoping it can just pull in repositories and tell me more about the code and history relating to it. There is a lot of potential to this. TLDRs are needed for code, LLMs will be an excellent replacement.