2 ms·
README is for humans if a human comes up and says "this project is for humans". Slop is excessively redundant. Basically "purple prose" of the technical docume
by subscribed 2mo ago
README is for humans if a human comes up and says "this project is for humans".
Slop is excessively redundant. Basically "purple prose" of the technical documentation.
But primarily: if its not worth writing, its not worth reading.
(I use Claude to prepare half of my technical documentation but then i review EVERY single file. And every single one gets extensively edited despite being coherent from the outset. I just feel like it would be disrespectful to get LLM spit something out and ask my colleagues to read it. Like.... come on.)
- bdangubic 2mo agoREADME should be written by the author of the code, it this case it is fully LLM written code so let the brother write the README. Also “README is for humans” might have been true awhile ago, these days README’s are being tailored to Agent as they write most of the code, not humans
- subscribed 2mo agoREADME is the first document of the repo read by the human stumbling upon the repository. Even if it's written by LLM it should be edited and managed by the human maintainer. Sharing unedited documentation like this is sloppy and speaks for itself ("I can't be bothered to control it"). Leaving readme only to agents is no class, since an alternative is one line of reference to the complete documentation for bots - no need to hijack the repo's first document designation with _that_.