It's funny because it's true ( sh.itjust.works ) Englisch

ILikeBoobies , vor 29 Tagen

https://readme.so/

jjjalljs , vor einem Monat

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.

_______ , vor einem Monat

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"

0x4E4F OP , vor einem Monat

This is eerie close to home! Completely illogical answers, yet somehow I'm to blame 🤨...

299792458ms , vor einem Monat

This is like when I was in school and spend half of the time using "word art" to set fancy titles

jol , vor einem Monat

I'm the opposite. I will write literally a book of poetry for the tiniest feature to justify my pay raise at the end of the year.

Landless2029 , vor einem Monat

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.

neidu2 , vor einem Monat

I'm the opposite. Wanna join forces?

0x4E4F OP , vor einem Monat

Definitely!

neidu2 , vor einem Monat

As long as your documentation doesn't require anything graphical, then I'm your man.

0x4E4F OP , vor einem Monat

Nope, nonetheleast. Maybe a screenshot or two.

I'll send you a DM 👍.

ssm , vor einem Monat

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

MonkderDritte , vor einem Monat

I do both well but it never ends. 😟

EvilCartyen , vor einem Monat

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

wesker , vor einem Monat

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.

Bishma , vor einem Monat

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.

independantiste , vor einem Monat

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

https://sh.itjust.works/pictrs/image/57ba9462-8dcc-4755-bedb-1605d2f53a70.gif

Successful_Try543 , vor einem Monat

Like my professor used to say: "Implementation is trivial, a trained ape can do it."

Steamymoomilk , vor einem Monat

The trained ape is AI and it works really well.

Hold on i gotta glue my pizza and drink my piss every 24hours before i finish this comment.

(Im joking)

wesker , vor einem Monat

https://c.tenor.com/x0OZJJFjCRQAAAAC/monkey-pissed.gif

A_Very_Big_Fan , vor einem Monat

He's doing a good job :3

stevedidwhat_infosec , vor einem Monat

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

ArbitraryValue , vor einem Monat

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".