The problem with “It’s self-documenting” is that there are inevitably questions about what it says, and there’s no additional resources to pull from.
I’m just this guy, you know. Except on Lemmy.
The problem with “It’s self-documenting” is that there are inevitably questions about what it says, and there’s no additional resources to pull from.
Totally agree. And I’d argue that we don’t even need technical writers. Even if all people do is correct grammar and spelling mistakes it would be helpful, let alone actually writing docs. It’s one of the easiest ways non-technical folks can get involved with open source projects.
If you know your weakness is writing documentation, please hire a technical writer.
I’m really thankful that I had a great English teacher in high school, and that my degree required a technical writing class. Being able to write a coherent email got me further in my career than the technical stuff I learned in college.
It’s also why the humanities are important. Stemlords who brag about not doing literature classes write terrible documentation.
You have to assume some level of end user knowledge, otherwise every piece of documentation would start with “What a computer does” and “How to turn your computer on.”
I’ve found the best practice is to list your assumptions at the top of the article with links to more detailed instructions.
The fact that KSP2 is still on Steam for $50 is criminal
I just watched the movie because there were boobies.
It’s all water under the fridge
You can’t automate away all the unpleasant and technical bits.
But it’s our job to try
I scratch my FPS itch with quick games of Ravenfield. The little stick men don’t yell at me and are almost as bad as I am.
Dying instantly when I spawn is not fun.
I avoid online games because I’m old and don’t have time to practice like teenagers do.
It also ages like crap because technology will always get better at that.
I dunno, I’d eat Costco hot dogs all day every day.