I grabbed this screenshot from an amusingly unhelpful page of help documentation.
Tags: technicalwriting
2 Responses to "Technical writing antipatterns"
1 | kristin nienhuis
can’t decide if i am “glad” to see this page or if I could have happily “existed” without… 
2 | Rhonda
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!
Comment Form
Categories
- accessibility (2)
- community (17)
- design (9)
- education (11)
- empathy (2)
- error messages (3)
- feedback (2)
- gtd (2)
- information design (15)
- photography (6)
- publishing (4)
- research (3)
- search (2)
- social media (2)
- user experience (28)
- user interface (11)
- visualization (5)
- webanalytics (1)
Search
- Things I’ve learned to do which I do no longer
- Rebuilding luggage for the real experience of air travel
- On bikes and needs
- How to make a good FAQ page
- Mini visitor’s guide to San Francisco
- And now for some good news
- If I had a spaceship I would land in Colorado
- How to give a memorably bad presentation
- You 2.0: A documentary on lifehacking
- Killface on the essence of information design
- Collaborative Filtering and Social Capital | Scrump: [...] this passage recently it put me in mind of the idea of the Solar Magnitude Forum put forward by Juliette Melton and Philip [...]
- ZAba: Hello Came across your blog totally by accident and really enjoyed it and your photoblog has some really intersting pictures. Nice eye ;) Regards
- Joey: Thanks for the post!
Most recently on Flickr
About
I'm into all things user experience, thoughtful design, photography, and vegetables. I collect good stuff here. Welcome.