Quality is important in technical publishing for a number of reasons. Documentation is part of the product it describes. If a product is supplied with little or poorly presented documentation this can have a negative effect on a customer’s perception of the product, even before they use it.
If the customer subsequently finds the documentation to be badly structured and full of technical inaccuracies, this may again have a further negative - and completely unwarranted - effect on the customer’s experience and perception of the product.
The provision of quality documentation is a visible demonstration of both pride in a product, and a commitment by its developers to users’ experience of it. When a product is supplied with a range of well developed learning resources that assist users in every aspect of their interaction with the product, this can only be a powerful contribution to its overall success.
My own commitment to quality in my work is founded upon the following two premises:
I have a strong academic background in a literary discipline. Therefore I approach my work in a methodical manner, paying attention to the clarity and fitness for purpose of my written work. A technical author’s role is essentially concerned with the development of learning resources, and having a background in education is itself a strength in this.
I’ve had experience of working in a wide range of technical environments. The technologies I have documented have ranged from complex telecoms components to software for primary school teachers. I’ve worked in situations which had very well developed platforms for their technical publishing, as well as places where the standard of technical documentation was poor. Throughout all this I’ve worked, observed and reflected on my experiences. I’ve seen what works, and what doesn’t, and developed my perspective upon this.