3 ms·
I disagree with this pretty vehemently. There is value in a doc telling you “this sounds like a complicated concept, but it’s actually not”. As a reader, it can
by mistercow 3y ago
I disagree with this pretty vehemently. There is value in a doc telling you “this sounds like a complicated concept, but it’s actually not”. As a reader, it can tell you that you don’t need to dig for deeper meaning or start searching for and understanding all the related concepts.
This particularly comes up when a concept has an unfamiliar name because of how it fits in with things conceptually, but at its core it’s just a very familiar entity with some other familiar entity tacked on, or something like that.
For an example off the top of my head: “A tagged image is simply a JSON object with an ‘image’ data URI property, and a ‘metadata’ object property”. The word “simply” is pulling weight here. It’s telling the reader that there is nothing else to the concept, that they already understand everything there is to know, and they can move on.
This can be misused, of course, and I think the post’s example is a valid one. But it’s a lot more useful to say when you should use something in your writing than it is to say “you probably shouldn’t.”