3 ms·
One that annoys me is when authors use multiple different terms for the same thing. In fiction, variety can be excellent, but in technical writing, it really ad
by KineticLensman 3y ago
One that annoys me is when authors use multiple different terms for the same thing. In fiction, variety can be excellent, but in technical writing, it really adds to the readers' workload. I remember reviewing a doc where, depending on which section you were reading, the terms 'design', 'architecture' 'system' and IIRC 'component framework' were used interchangeably. This made following the reasoning hard because the doc was itself a review of two distinct technical solutions.
This often happens when a doc has multiple authors and no global consistency checking.