Why Your User Guide Needs a Style Guide Too

Why Your User Guide Needs a Style Guide Too
Editing is arguably the most important process of technical authoring, and the one that takes up most of our time. I'm a technical author, and I find editing quite challenging when we have several projects on the go at the same time. Every company has their own branding guidelines; some also have special terms or acronyms that they use. Often, the rules and preferences for the editing process overlap from client to client, and we need to know everyon

The Importance of a Great User Guide

The Importance of a Great User Guide
Mathew and I now offer technical authoring services, but we both have a history of working in IT support. Mathew worked for BT and the NIHR before becoming a technical author. I worked at Mazars and StepChange before getting a great service desk job at the NIHR, part of the NHS. Our service desk experience has helped us to understand the benefits of a good user guide. Great documentation is crucial for end users, and it also really helps the service

Study reports 26 per cent struggle with instruction manuals

Fellow technical writers may be interested to read this piece in the Daily Mail. In a thinly-veiled advertisement for a tech support helpline, the report claims that 26 per cent of people have their Christmas Day fun ruined by complicated instruction manuals. I don't mean to take this festive survey too seriously - especially given the sources involved. But can it really be the case that technical writing causes still causes problems for users? I'd be i
Red Robot Media
Show Buttons
Hide Buttons