I've read some very bad READMEs. I mean really bad, like not even tell me what the program is for bad. I remember one that forgot to tell me what its own name was.
But really this is basic usability testing. I still run into issue at work where its like "Oh, you need to install C# runtime" or some other thing so it can even start. We have since fixed the build chain to check for that.
I know its hard to step out of your own context but that is what documentation is.
There are over 600 definitions of the work "run" and over 400 for the word "set" and you really expect that some end user in another industry cares what your context is. It's our job to care about their context because they are paying us to solve their problem.
But really this is basic usability testing. I still run into issue at work where its like "Oh, you need to install C# runtime" or some other thing so it can even start. We have since fixed the build chain to check for that.
I know its hard to step out of your own context but that is what documentation is.
There are over 600 definitions of the work "run" and over 400 for the word "set" and you really expect that some end user in another industry cares what your context is. It's our job to care about their context because they are paying us to solve their problem.