Dave's WordPress home in the Fediverse :-)

How we document APIs. We did a lot of work on API docs this morning. Claude had done a draft, which we published, and turned over to users, and on review realized it was insufficient. That was the word I used, and rolled up my sleeves, told Claude we’re going to get this stuff right and set a pattern as we go forward. At the end I asked Claude to summarize what we agreed on, and it’s more or less exactly what I was aiming at. If you’re working with Claude on docs for APIs, I offer this up as open source, feel free to point your Claude at this doc. I have a vested interest, in my job I read a lot of awful API docs. #

Last update: 7/27/26; 12:48:20 PM.

Discover more from daveverse

Subscribe now to keep reading and get access to the full archive.

Continue reading