Writing documentation for AI: best practices

https://docs.kapa.ai/improving/writing-best-practices

90•mooreds•4h ago

Comments

emil_sorensen•4h ago

OP here. It's kind of ironic that making the docs AI-friendly essentially just ends up being what good documentation is in the first place (explicit context and hierarchy, self-contained sections, precise error messages).

esafak•4h ago

Now people just have a better incentive :)

mooreds•4h ago

"GEO[0] has entered the chat."

We see a surprising number of folks who discover our product from GenAI solutions (self-reported). I'm not aware of any great tools that help you dissect this, but I'm sure someone is working on them.

0: Generative Engine Optimization

nlawalker•44m ago

Honest question - what do you mean? What's the better incentive?

jilles•3h ago

It's similar for writing code. Suddenly people are articulating their problems to the LLM and breaking it down in smaller sub-problems to solve....

corysama•2h ago

It has changed how I structure my code. Out of laziness, if I can write the code in such a way that each step follows naturally from what came before, "the code just writes itself!" Except now it's literally true :D

arscan•2h ago

In other words, people are discovering the value of standard software engineering practices. Which, I think is a good thing.

bobbiechen•2h ago

Related: "If an AI agent can't figure out how your API works, neither can your users" (from my employer's blog)

https://stytch.com/blog/if-an-ai-agent-cant-figure-out-how-y...

QRY•1h ago

Thank you for sharing this, it's really helpful to have this as top-down learning resource.

I'm in the process of learning how to work with AI, and I've been homebrewing something similar with local semantic search for technical content (embedding models via Ollama, ChromaDB for indexing). I'm currently stuck at the step of making unstructured knowledge queryable, so these docs will come in handy for sure. Thanks again!

shafyy•27m ago

It's the same for SEO also. Good structure, correct use of HTML elements, quick loading, good accessibility, etc. Sure, there are "tricks" to improve your SEO, but the general principles are also good if you were not doing SEO.

basisword•3h ago

I wish companies would invest more in docs. It's too hard to keep the quality high if it's just another thing for engineers to do. I've seen too many cases where a small group invests lots of time and effort bringing the docs up to standard and then another person or group comes along and starts dragging down the quality because they can't be bothered taking to time to see how and where their information fits and ensuring the formatting and styles are maintained.

Eventually the quality drops to such a level that some poor bastard spends their time bringing it all back up to standard - and the cycle repeats.

simonw•1h ago

The most important characteristic of any internal documentation is trust. People need to trust it. If they trust it, they'll both read it and contribute to it. If they don't trust it they'll ignore it and leave it to rot.

Gaining that trust is really hard. The documentation needs to be safe to read, in that it won't mislead you and feed you stale information - the moment that happens, people lose trust in it.

Because the standard of internal docs at most companies is so low, employees will default to not trusting it. They have to be won over! That takes a lot of dedicated work, both in getting the documentation to a useful state and promoting it so people give it a chance.

MK_Dev•3h ago

How do you turn off dark mode on that site? Hurts my eyes

emil_sorensen•3h ago

Thanks for the feedback. We should definitely add that. :)

retsibsi•2h ago

In Firefox, Reader View (F9) seems to handle it well.

croes•3h ago

I thought one of the use cases of AI is to write documentation? And I thought AI adapts to humans, now it seems the other way around

svachalek•2h ago

AI doesn't adapt to anything. Training creates a fixed model that doesn't change until you replace it.

theletterf•1h ago

Don't fall into the trap of the new SEO for AIs. LLM are just like users. https://passo.uno/writing-for-llms-ai-chatbots/

steveklabnik•1h ago

Most of the things described in this document are also good for humans. The justification is different, but the result is the same.

pixl97•1h ago

Or as I like to say, if current AI cannot explain your documentation well, then it's very likely humans can't either, your documentation sucks.

AvAn12•1h ago

Makes web scraping easier too.

intellectronica•41m ago

Excellent advice. Good documentation makes a huge difference in AI-assisted software development.

remram•30m ago

AI will make it easy to get your documentation up for your users!

> Step one, write the documentation yourself.

> Step two, bots hit your website hundreds of times per minute.

> Step three, users never come to your site, they use OpenAI's site.

> Step four, ??? openAI profits

namuol•19m ago

Good docs don’t fix bad apps or APIs though. I get the sense that demand for docs is a signal that there’s a deeper problem with DX. Good docs generally only exist in places where they’ve given the rest of the DX enough love in the first place, so it’s more of a mark of quality than a means to quality.

wiremine•9m ago

A bit off topic, but I've been finding myself write "plan.txt" files for claude code.

1. Write plan 2. Ask Claude to review for understandability 3. Update as needed until it's clear 4. Execute the task(s) in the plan.

I'm finding Claude gets much further on the first pass. And I can version the plans.

andy99•7m ago

As soon as some widget in the corner of a site wiggles to get my attention, I leave. If you/they want people to actually read their articles they shouldn't try to distract readers as soon as they start.

Calling Go from Elixir with a CNode in Crystal

The Technical Face of Payments as a Service

S1: Simple Test-Time Scaling

After 10 years, we're past peak RGB, but don't celebrate yet, stealth PC purists

Apple's Liquid Glass in the Browser

The iPhone SE was the best phone Apple ever made, and now it's dead (2018)

Ireland Is Failing Palestine

Testing the directional relationship between social media use and materialism

CNCF Slack workspace will be converted from an enterprise plan to a free plan

Free access Udemy (1 day) – ML for EEG feature extraction. Practical Course

Glass Cage iOS 18.2 Vulnerability

Halt and Catch Fire Syllabus

Websites Are Tracking You via Browser Fingerprinting

PEP 779 – Criteria for supported status for free-threaded Python

"A Crowd-Driven Platform That Lets People Vote

Show HN: Low-level Handwritten Digit recognition

Fast multiplayer 3D renderer, written in Rust

Show HN: I built an app to remember what I learn from articles and videos

She Won. They Didn't Just Change the Machines. They Rewired the Election

Flock Safety Response to Illinois LPR Data Use and Out-of-State Sharing Concerns

Salter vs. Meta Platforms, Inc. Decision and Order (3/18/2024) [pdf]

GPT-4o shows humanlike patterns of cognitive dissonance moderated by free choice

We Are All Victor Frankenstein: Our Romantic Dream of Artificial Intelligence

Earliest evidence of humans in the Americas confirmed in new study

What's Wrong with That?: How Israel Trained and Armed an ISIS-Linked Gaza Milita

Show HN: Built a one-time tool for small biz owners who hate subscriptions

Developer Resume as a VSCode UI

Pattern matching and exhaustiveness checking algorithms implemented in Rust

Fed's Powell warned there'd be places in the US where you 'can't get a mortgage'

In-Memory C++ Leap in Blockchain Analysis