3 ms·
> The post is about removing some unnecessary wording from technical documentation that doesn't add anything, and as an aside can sometimes imply complex tasks
by codeflo 3y ago
> The post is about removing some unnecessary wording from technical documentation that doesn't add anything, and as an aside can sometimes imply complex tasks are simpler than they are to the detriment of the app/library/service it's documenting.
I'm not sure that's a fair summary of the article. I just reread it: at no point does it suggest removing superfluous words in general, it's specifically about "words such as easy, painless, straightforward, trivial, simple and just", because those in particular are "jolting", "upsetting and annoying" and "infuriating". What you frame as an "aside" is in fact the first and last paragraph of the article.
> I have no idea why you'd think this implies some personal failing or that it is advice for "babies"
You're missing a level of indirection here, the readers of the documentation are the “babies”, not the writers who take this article's advice. This is advice for people who write for people who act offended when reading the word "simply" in technical documentation, and I'm questioning the dynamics of that.
It's obviously fair to criticize the word choice on my part, there were less incisive ways to phrase that. But then, it's the article that claims that the usage of the word "just" in the sentence (the article's example) "[then] we will just edit the users_controller.rb" is "condescending", and I think that's "simply" (sic) insane.
- zabzonk 3y agojohn lennon once said "never use 'just' in a lyric - it's lazy" (i paraphrase) and i think he might have had simmilar opinions on such things as "trivial". sadly, we will never know.
- lowercased 3y ago* He used 'trivialities' in a song (When I Get Home) * She was "just" seventeen (arguably that was Paul's line, but John didn't override it, and kept his name on it) * "(Just like) Starting Over" has 'just' in the title and lyrics. * "Just" gimme some truth. * "I'm just a jealous guy" Rules are meant to be broken, perhaps? Or maybe he would just cop to being lazy?
- deleted 3y ago[deleted]
- zabzonk 3y ago> Rules are meant to be broken, perhaps? Or maybe he would just cop to being lazy? both? the quote i paraphrased was from hunter davies' authorised biog of the beatles but i still think it is a good rule
- lowercased 3y agoi don't completely disagree. I wonder how much of that was a flippant remark, how much his own views changed in the intervening years.