Optimizing technical docs for LLMs
docs.kapa.ai
Optimizing technical docs for LLMs
1–10 of 27 posts
Re: Optimizing technical docs for LLMs
#2Re: Optimizing technical docs for LLMs
#3Re: Optimizing technical docs for LLMs
#4Re: Optimizing technical docs for LLMs
#5I wonder if an unintended side effect of this AI hype cycle is a huge investment in more accessible applications.
Re: Optimizing technical docs for LLMs
#6I love that writing LLM-friendly docs is just... writing good docs. There's a ton of overlap between accessibility work and preparing things to be used by LLMs. I wonder if an unintended side effect of this AI hype cycle is a huge investment in more accessible applications.
One surprising (to me at least) benefit of hooking up an LLM to your docs is that it is actually a really useful way to find gaps in your docs. For example, when an LLM cannot answer a user question, there's a good chance it's because the answer is not documented anywhere.
Re: Optimizing technical docs for LLMs
#7I love that writing LLM-friendly docs is just... writing good docs. There's a ton of overlap between accessibility work and preparing things to be used by LLMs. I wonder if an unintended side effect of this AI hype cycle is a huge investment in more accessible applications.
If you yell and swear at the chatbot, you'll get the response most similar to how a human would respond to yelling and swearing. I know the stereotype about drill instructors, but does that even work for marines, or is it just an exercise in learning to cope with stress?
Re: Optimizing technical docs for LLMs
#8I've (obviously, like almost everyone) experimented with creating stuff with ChatGPT, and… hmm. I was going to write "it made web pages like that", but: Clever Hans. I don't know if I might have subconsciously primed it to, because that's also something I like.
Re: Optimizing technical docs for LLMs
#9Re: Optimizing technical docs for LLMs
#10I felt most of this was just plain common sense. People read things by headings and sub headings. People look for relevant documentation for product x under product x not y. QA and code samples primes the LLM for what most developers like myself hunt for (a quick answer or a simple code snippet). The forum part got me. Seeing as forums tend to be variable in the quality and quantity of info. If the author(s) suggest…