You must log in or # to comment.
My best READMEs are the ones I write well before I’ve finished the code. The README bears little resemblance to reality, but it’s the easiest to read.
I think a lot of people are kind of bad at written communication. It’s not an easy skill.
Often at work folks will write twice as many words and clauses as needed. The Hemingway editor ( https://hemingwayapp.com/ ) isn’t perfect, but I recommend they take a look at it.
Them: “Read the docs, this is a mature project!”
The documentation: “Coming soon!”
Me: “It says its coming soon.”
Them: “Its open source, how about you contribute instead of demand?”
Me: “What?”
System notification: “Banned, lol”
This is eerie close to home! Completely illogical answers, yet somehow I’m to blame 🤨…
I’m the total opposite, my documentation is very thorough, my code looks like it was made by a monkey
Like my professor used to say: “Implementation is trivial, a trained ape can do it.”
