Hey, I'm new to GitHub!

LinearArray@programming.dev to Programmer Humor@programming.dev – 1226 points –
299

You are viewing a single comment

This is why I was told to always write instructions or documentation for dummies, because we never know who is going to use them and it might come back to bite us in the ass. Seems to be a rare thing, since most of the tutorials or instructions I've seen during my life (real and Internet) assume people know or omit important details that seem minor or the formatting is terrible (use screencaps if possible, make it easier for everyone).

Seems to be a rare thing,

Didn't you know? All the cool kids these days skip documentation and just hang out on discord, where you can get a laggy response to your query about build dependencies in 2-3 business days.

Reminds me how many years ago I was complaining that people would go ask questions on irc instead of reading docs or posting on a forum so it could be indexed. Looks like nothing changed

You took that phrase wrong, I meant about people doing tutorials or documentation for dummies, that’s the rare thing, most are done assuming everybody knows everything and as such are poorly written/detailed/explained.

I try to write documentation/instructions for dummies, because often, I'm the dummy when I have to dig back into the code again after not touching or thinking about it in months or years.