2 thoughts on “Technical writing antipatterns”

  1. can’t decide if i am “glad” to see this page or if I could have happily “existed” without… :-)

  2. Looks like someone was writing for an ex-boss of mine! His ‘metric’ for my ‘worth’ as a technical writer from one release to the next was how many more pages were in Release 4, compared to Release 3.

    *My* metric for the same documentation was how many LESS pages there were. Fewer pages meant any or all of these:
    * tighter writing and editing
    * removal of topics no-one cared about or wanted, or that were repetitive of other topics (e.g. an ‘add widget’ and an ‘edit widget’ topic were often very similar and could be combined)
    * more usable software that didn’t require a 400 page manual to use it!

    BTW, I no longer work for that company—and nor does he!

Leave a Reply

Your email address will not be published. Required fields are marked *