David BissetInteresting. Someone didn't like it when documentation uses the term "simply" and "it's easy" so much they made a site out of it:
It's actually a GOOD site too, and if you write docs or marketing it might be worth a look.
JJ Celery@davidbisset this drives me *nuts* in documentation because it assumes a level of knowledge on par with the person who wrote the docs, which is rarely the case.
What I love when I read docs is absence of justs and simplies, but instead something like "this doc assumes that you have some x knowledge and if you don't you may want to start at (link to x knowledge)"
I try to do same when writing docs myself.
SarahATX@jjcelery @davidbisset
Mark Baker calls this "qualifying" the reader, which I love and reference this concept often with the writers on my team. 😊
Mark Baker calls this "qualifying" the reader, which I love and reference this concept often with the writers on my team. 😊
@purplelotus13 @davidbisset Source please? I love collecting the goods.
JW prince of CPH@jjcelery @davidbisset Also in the same category: Using technical terms - or God help us, technical abbreviations! - when it isn't strictly necessary, without explaining what they mean.
Kevin Teljeur ❄️@jjcelery @davidbisset @whalecoiner For what it’s worth, this makes technical books unreadable too, especially when it comes with a jaunty conversational style. Just give the facts, don’t tell me how easy it really is and that I’ll hopefully ‘get it’ later on.