|
|
|
|
|
by mkovach
16 days ago
|
|
> The way the LLMs write (Claude perhaps?) With short phrases separated by colons, commas, or full stops, is so poor and frustrating. This is exactly why I keep a WRITING.md file alongside AGENTS.md or CLAUDE.md. Most people spend time telling the model what to build, but very little time telling it how to write. LLMs are surprisingly good at following explicit style guidance if you bother to give it to them. Mine includes conventions like avoiding unnecessary colons, em dashes, and sentence fragments masquerading as emphasis. Basically, AI-isms and any grammatical errors I tend to make. It also points to writers whose technical prose I admire. Brian Kernighan and Rob Pike are great examples: clear, conversational, and readable without trying to sound important. I've always tried to do two things with documentation: 1) Make it readable and 2) Make people want to read it. A WRITING.md file helps with both points. If you're generating documentation regularly, it's worth having your agents reference a WRITING.md file. The improvement in readability is often much larger than any gain you'll get from switching to the latest model, and it can keep your documentation consistent between model switches. |
|
I disagree with the person below - I don't think its a wrongheaded goal in and of itself to get better ai generated writing. I read ai output half of my day, I may as well try and make it better for my own sake. Passing that onto other people is an entirely unrelated field of problems, and passing it off as stuff you authored yourself is just plagarism.