3 ms·
I don't think one needs to dogmatically avoid words like "just" and "easy" in technical documentation — provided the thing described is really just easy or simp
by atoav 3y ago
I don't think one needs to dogmatically avoid words like "just" and "easy" in technical documentation — provided the thing described is really just easy or simple.
The problem is that many technical writers want the thing they are describing to just be easy, because they are selling a solution. But you wanting something, doesn't make it so.
On top of that what is easy is relative. To a life long programmer with administrator-experience a thing might be easy and obvious, to someone who never opened a CLI and is not a programmer it might not be.
IMO it is benefitial for technical documentation to be written in a way that does not assume too much prior knowledge.
TL;DR: reserve words like just, easy and simple for things that — to the layperson — are truly just, easy and simple