Top
Best
New

Posted by edent 12 hours ago

I paid people to try and follow my README(shkspr.mobi)
360 points | 186 commentspage 4
trollbridge 6 hours ago|
This is one of those things LLMs are really good at.

Create a new container or sandbox, copy in the git repo or point it at your staging docs, and see what happens.

calmingsolitude 6 hours ago|
LLMs are good at reading READMEs. They are absolutely horrendous at writing them.
trollbridge 5 hours ago||
I try to actually write my own readme a still, but it’s obviously a rapidly vanishing art.
apt-apt-apt-apt 7 hours ago||
Understandability depends on the audience.

E.g. as someone who doesn't "Fediverse", the intro section leaves me having no idea what an ActivityBot is or what an ActivityBot account is.

bgolson 11 hours ago||
Excellent article! Thank you for the reminder that I need to be spending more time with users… or hirelings :)
jpitz 9 hours ago||
Also - formalize what can be. There may be e.g. opportunities to write scripts that can be tested and linted. I realize this isn't always possible, but I do think it should be ruled out rather than ignored.
andai 10 hours ago||
>My jokes aren't funny and are actively confusing.

You didn't have to murder me like that!

joshuaS98 7 hours ago||
> I hadn't actually explained what the software would do.

This is my #1 annoyance when looking at a trending repo

_clark_kent 10 hours ago||
I think the problem is that this doesn't simulate for people who can't or won't read the manual
jodrellblank 8 hours ago||
Software X has a feature.

Me: "hi support, feature is not available??"

Support: "it doesn't work in that situation. Here's a link to our documentation with two dozen bullet points about where and when that feature doesn't work".

It's as if you selected a cell in Excel, and the copy-paste buttons were missing, and you raised a support case with Microsoft and they said "copy-paste does not work if your spreadsheet was opened from a NAS share. It's documented here that it doesn't work: <link>".

That is documentation as a defense, instead of the company putting in the effort to make the thing work, they put in documentation that it doesn't work so they can blame the user who "won't read the documentation".

andai 10 hours ago||
Actually, that's a good point. I often run into issues that would have been solved by more careful reading.

Paying people to record themselves using your software without reading the instructions might actually be very informative.

I imagine the ideal is a product that requires no manual. That's not always doable, but sometimes it is. Sometimes you can get very close!

pinkmuffinere 6 hours ago||
> My jokes aren't funny and are actively confusing.

:’)

parasti 6 hours ago||
Coolest thing I've read in months.
scriptsmith 11 hours ago|
Somewhat related question: what is it about READMEs that AI agents love to dump the most useless, hard to contextualise & comprehend, irrelevant rubbish into them that makes understanding a project and onboarding so hard?

It feels like like the AI agents can't help themselves sometimes, and the judgement exercised around what's included and omitted is baffling.

But maybe READMEs have always been this bad, and AI agents have raised the baseline?

saghm 10 hours ago|
That sounds pretty similar to what I get from LLMs regardless of what they're writing for. Any time I get more than a paragraph out from an LLM, it tends to have of a lot of irrelevant details or unnecessary hedging, and I have to either wade through it to find the actual answer or try to convince it to make it more direct.

As someone on the spectrum, this does happen to me with people sometimes too; I struggle when asking a question and getting an answer that doesn't fit the "shape" of what I expect (e.g. asking a yes or no question and getting a relatively long sentence in response that doesn't contain either "yes" or "no" in it, which means I need to do the equivalent of applying it as a diff to my mental model and seeing if there are conflicts). This happens less frequently with other humans though, and on average the amount of effort I need try to figure out what they're saying is a lot lower. This doesn't make it less frustrating when I get that kind of output from an LLM, but it doesn't surprise me all that much that it happens.

I'm sure I do this all the time to people too, though. One of the biggest lessons I've learned in the past several years is that I communicate in ways that I'd probably have trouble understanding in reverse a lot more frequently than I realized, even I still do the things I find confusing from others less often than most people I interact with. I'm sure a lot of people might find this comment to be pretty much exactly like what I'm complaining about even though I feel fairly confident at least in this moment that my point is clear.

Telaneo 10 hours ago||
> As someone on the spectrum, this does happen to me with people sometimes too; I struggle when asking a question and getting an answer that doesn't fit the "shape" of what I expect (e.g. asking a yes or no question and getting a relatively long sentence in response that doesn't contain either "yes" or "no" in it, which means I need to do the equivalent of applying it as a diff to my mental model and seeing if there are conflicts). This happens less frequently with other humans though, and on average the amount of effort I need try to figure out what they're saying is a lot lower. This doesn't make it less frustrating when I get that kind of output from an LLM, but it doesn't surprise me all that much that it happens.

I've have people in my life where I've got situation going to the point I got sick of it and just started responding 'That didn't answer my question. Do you remember what my question was?'. Turns out many people seem to invent out of whole cloth what your question is rather than actually responding to it. Seems like a whole lot of wasted effort. I mean, it's one thing to ask a yes or no question and getting 'it depends on X, Y, Z, blah blah blah', or just 'I'm not sure/don't know'. There have been far to many cases where I ask something and the response is functionally 'well you see, it all began in 1969, back when dinosaurs ruled the earth'.

LLMs seem to atleast actually respond to your question. The question might be phrased in a way which doesn't match what you intended, and the answer will be verbose and require you to wade through prose to actually find it, or it might just be wrong, but it will at least be an answer to the question you gave it.

saghm 1 hour ago||
My personal experience is that people who respond to my like this do tend to understand what I've asked but aren't particularly direct in the way they describe things, which both causes them to give answers hard for me to understand and would cause them to probably not do a great job trying to phrase my question in their own words (and very few people are memorizing the conversation so that they can recite parts of it back later on).
More comments...