|
|
Subscribe / Log in / New account

The thing nobody wants to pay for - documentation

The thing nobody wants to pay for - documentation

Posted Feb 22, 2024 17:23 UTC (Thu) by kleptog (subscriber, #1183)
In reply to: The thing nobody wants to pay for - documentation by fest3er
Parent article: The things nobody wants to pay for

It's also possible to write voluminous documentation that is not useful. My experience with the Microsoft Azure documentation the last few months has been that there's loads of documentation that somehow fails to actually answer the questions I have. ChatGPT tends to give useful answers that, if you squint a bit, match what the documentation says, but something you would not have come up with yourself.

It does raise the question of what the target is of documentation these days. Are we expecting people to actually read all the docs, or do they just want their questions answered? For the latter case I see a promising future for LLMs. The other style documentation I use often are walk-throughs that go step-by-step to set up some environment, because that often involves lots of related tools working together, something you'll not find out by reading the docs of the individual tools.

At $DAYJOB we're experimenting with LLMs to write documentation. Not that it produces perfect results, but it gets you 90% of the way and maintains a consistent style. And people appear to be happier tweaking the results compared to writing from scratch. As so often with coding, a lot of documentation is just obvious boilerplate in a slightly different format, so letting the computer generate that and letting the expert fill-in the non-obvious looks to be a great time-saver (and we actually get docs, instead of nothing which what we have now).


to post comments


Copyright © 2025, Eklektix, Inc.
Comments and public postings are copyrighted by their creators.
Linux is a registered trademark of Linus Torvalds