I’m the total opposite, my documentation is very thorough, my code looks like it was made by a monkey

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.

As long as you provide a list of dependencies, you’re cool in my book

Code is more or less deterministic, communicating with other humans using something like the English language - much harder.

Lots of communication is open ended and up to interpretation especially with things like incorrect grammar usage and/or slang

Take your time, get it as close to right as you can the first go around

Am I the only one who writes the Readme as I add features and do my commits.

Don’t leave your homework until the end and cram away just before it’s due.

Code every other day.

Code. Then review and document.

I also try to maintain my feature list in my Readme. Essentially my roadmap. Work my way down the list and write Code as features are added/updated.

I’m the opposite. Wanna join forces?

This is why my programs don’t come with documentation. If you want to use them, the best I can do is a messy script that “works for me”.

Well, I for one am thankful you lot see so bad at explaining yourselves or I’d be out of a job

Love, the technical writer

That hit me right in the gut.

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”

I pride myself on writing pretty good technical docs. But there’s always a motivation hurdle at the beginning, that I have to get over.

I do both well but it never ends. 😟

https://readme.so/