Writing Documentation for API's

Discussions
1

I’ve been using cursor for a while now. The coding agents whether Composer, Grok, Claude, GPT blow my mind for writing code.

However… they all seem to kind of suck at writing documentation.
Currently I’m creating API documentation and whilst I’ve created something that’s excellent in terms of an HTML documentation interface - the English that goes with it leaves much to be desired - both in terms of context, scope and writing style.

As a result I find myself still cutting and pasting things into ChatGPT to turn it back into something a human could read (The irony being it probably won’t be a human that reads it).
Be curious to know anyone elses findings, tips, etc here.

5

Try having an LLM create a skill based on api documentation (or any writing) that you like and then using that skill to write the documentation. LLMs still fall short on writing across the board so this is a common problem. I have a unique version of the asd-ste100 skill I like when it comes to writing documentation. It keeps things concise and cuts out some of the fluff, which to me has always been the biggest tell/annoyance.