ArtsAutosBooksBusinessEducationEntertainmentFamilyFashionFoodGamesGenderHealthHolidaysHomeHubPagesPersonal FinancePetsPoliticsReligionSportsTechnologyTravel

Quality Assurance for Technical Writers

Updated on February 24, 2017

Webster defines quality assurance as “a program for the systemic monitoring and evaluation of the various aspects of a project, service, or facility to ensure that standards of quality are being met.”

As a technical writer, quality assurance must fit a broad range of undertakings. According to the Society for Technical Communication web page," The value that technical communicators deliver is twofold: They make information more usable and accessible to those who need that information, and in doing so, they advance the goals of the companies or organizations that employ them."

How the technical communicator goes about these tasks and does so successfully guarantees the quality expected of an organization.

To break the process down into manageable parts, we will discuss the following aspects of quality assurance for technical writing:

1. Editing

2. Copyright Basics

3. The Use of Style Guides

4. Peer Review

5. Documentation Control

6. Testing & Evaluating the Information

What to Avoid

  • Jargon

  • Techie Talk

  • Wordiness


Of top priority for technical editors is completely accurate information fashioned in such a way that it is easily understood by the average reader or user. Content must be totally precise and comprehensible.

A technical editor first edits a document for spelling/grammar, punctuation and organization making sure the document has fluidity meaning "flow". To assist in the editing process, a writer has some help from software tools, but writing well and being concise is a learned practice. Organization of material is key as well the use of lists, bullets and numbers which organize information in understandable and clear steps. The document should then flow from start to finish with the use of transitions and images that clarify purpose.

The technical editor sacrifices a certain amount of creativity for the sake of reader understanding when they reduce industry jargon, techie talk and the use of way too many words in their attempt to explain a process.

Let me explain - I once received a very wordy explanation and the crux of it was - "We are doing away with our PBX and switching to VoIP." I knew what this meant, but I couldn't imagine other receivers understanding this lingo. A clearer explanation would have been - "We are doing away with our old phone system and implementing VoIP. VoIP stands for voice over Internet protocol meaning instead of traditional telecom wiring your voice communication will now be transmitted over the Internet." You would then go on to explain what this means to the user which may include training and tutorials, but if the reader does not understand the first sentence or two, he or she may not continue to read what is potentially important information about a new process that will certainly affect them on a daily basis.

Next, if input is coming from various sources, it is important that it be synchronized and formatted according to company organization standards so the document has a uniform feel. Synchronizing information across a company or organization structure is often done with the use of style guides.

The Use of Style Guides

A style guide or style manual is a set of standards for designing and writing information for an organization or company.

Style guides are really a quality assurance tool that help define and maintain consistency for an agency’s websites, TBOKS (technical bodies of knowledge), documents and publications.

Style guides establish protocols for details like page layouts, formatting and appropriate company or organization branding. Rules may include what color and fonts can be used and how logos must be displayed.

Kevin Cain, writing for the Content Marketing Institute, states that, "...every company needs a content marketing style guide. Good style guides document and standardize everything, from the unique terminology a company uses to describe itself to its spelling and punctuation preferences." He goes on to say that, " In doing so, the style guide becomes a basic road map that everyone can follow to help create consistent, high-quality business communications."

Read also Cain's article, "6 Steps to Creating Your Content Marketing Style Guide"


Copyright Basics

When considering the information you are publishing, do not forget the important rules regarding copyright. According to, "Copyright is a form of protection provided by the laws of the United States (title 17, U. S. Code) to the authors of 'original works of authorship', including literary, dramatic, musical, artistic, and certain other intellectual works. This protection is available to both published and unpublished works."

The source of this definition and more information on registering copyrights, use of copyrights and international copyright laws can be found at:

Copyright Basics

Copyright protection can relate to the technical writer in two ways:

1. Avoiding plagiarism: Taking care to properly site and/or get permission to use works that that are copyrighted material.

2. Protecting work: Taking care to protect your own work by knowing and enforcing copyright protection laws.

It is important to familiarize yourself with copyright laws and the basics of the topic especially when utilizing the works of other writers.


Peer Review

And while protecting yourself in the area of copyright, peer review can also provide a sense of security. According to Geoff Hart on, the goal of peer review is, " obtain expert critiques of your writing." Hart says what's important here is to learn to distinguish between valid and invalid criticism, but in the end it should help you be a better writer.

I like that Hart uses the word, "honing". To hone is to sharpen and one of the best ways to sharpen your work is to have a peer writer provide you with a constructive critique. The goal is not to rewrite your work, but to assist you in becoming skilled at writing well through professional suggestion.

Let's face it - there's a risk when your work is reviewed. But, according to a article, reviewers should be looking for a range of potential problem areas when they review such as:

  • Interest level, adaptation to audience
  • Persuasiveness, purpose
  • Content, organization
  • Clarity of discussion
  • Coherence, use transition
  • Title, introduction, and conclusion.
  • Sentence style and clarity
  • Handling of graphics

It's not just negative comments that will assist a technical writer when their work is peer reviewed, positive comments also assist in helping the writer know areas where their work is spot on.

Even so, having work reviewed by a colleague or peer is a QA (quality assurance) step that can save embarrassing reports of mistakes later by the reading public.


Documentation Control

So you're done with the work and now what? "Documentation control," according to Susan Ward, Small Business: Canada, "is the process of handling documents in such a way that information can be created, shared, organized and stored efficiently and appropriately."

Ward suggests, Steps to Creating a Document Management System which includes:

1. What are the rules for creating documents?

2. How will we store documents?

3. How can retrieving documents be simplified?

4. How can we make/keep our documents secure?

Ward encourages that you can put a document management system in place without costly software or outsourcing. "The system", says Ward, "doesn't have to be complex; you just have to invest some time in planning and implementing it."

Testing and Evaluating the Information

And the final step is evaluation. Successful evaluation and testing of information is important in determining the quality of the work completed. The best test and evaluation comes from the reader/customer utilizing the information so interaction with these individuals is key.

The customer is the best source for confirming that the information is accurate. A select group of users can be useful in becoming a "test bed" for created information. By opening the information up to certain users before it goes public, the technical writer can garner input on a smaller scale and make changes before the information goes out to a greater audience.

Allowing the reader a chance to respond through the use of survey tools is an excellent way to evaluate the usefulness and understandability of materials. From responses given, the writer and/or writers can then "hone" or sharpen the information accordingly.

In Review



Technical writing has been around a long time - since man first tried to explain something to his fellow man. Over the past 60 years, with advent of computers, technical writing has grown to include not only print manuals, but on-line documentation and technical bodies of knowledge. Utilizing the pieces of the above pie outlined in this article will ensure that technical writing is done with professionalism and expertise with the main goal of benefiting the reader or user.

Other Links

Modern Language Association
Amercian National Standard Institute
International Organization for Standardization


Cain, K. (2012, March 5). 6 Steps to Creating Your Content Marketing Style Guide. Content Marketing Institute. Retrieved February 26, 2014, from

Copyright Basics. (n.d.). Retrieved February 26, 2014, from

Defining Technical Communication. (n.d.). Society for Technical Communication.
Retrieved February 10, 2014, from

Hart, G. (2012, May 21). Peer Review Strategies for Technical Writers. TechWhirl. Retrieved February 26, 2014, from

Online Technical Writing:Strategies for Peer-Reviewing and Team-Writing. (n.d.). Online Technical Writing: Strategies for Peer-Reviewing and Team-Writing. Retrieved February 26, 2014, from

Ward, S. (n.d.). Document Management. Small Business: Canada. Retrieved February 26, 2014, from


This website uses cookies

As a user in the EEA, your approval is needed on a few things. To provide a better website experience, uses cookies (and other similar technologies) and may collect, process, and share personal data. Please choose which areas of our service you consent to our doing so.

For more information on managing or withdrawing consents and how we handle data, visit our Privacy Policy at:

Show Details
HubPages Device IDThis is used to identify particular browsers or devices when the access the service, and is used for security reasons.
LoginThis is necessary to sign in to the HubPages Service.
Google RecaptchaThis is used to prevent bots and spam. (Privacy Policy)
AkismetThis is used to detect comment spam. (Privacy Policy)
HubPages Google AnalyticsThis is used to provide data on traffic to our website, all personally identifyable data is anonymized. (Privacy Policy)
HubPages Traffic PixelThis is used to collect data on traffic to articles and other pages on our site. Unless you are signed in to a HubPages account, all personally identifiable information is anonymized.
Amazon Web ServicesThis is a cloud services platform that we used to host our service. (Privacy Policy)
CloudflareThis is a cloud CDN service that we use to efficiently deliver files required for our service to operate such as javascript, cascading style sheets, images, and videos. (Privacy Policy)
Google Hosted LibrariesJavascript software libraries such as jQuery are loaded at endpoints on the or domains, for performance and efficiency reasons. (Privacy Policy)
Google Custom SearchThis is feature allows you to search the site. (Privacy Policy)
Google MapsSome articles have Google Maps embedded in them. (Privacy Policy)
Google ChartsThis is used to display charts and graphs on articles and the author center. (Privacy Policy)
Google AdSense Host APIThis service allows you to sign up for or associate a Google AdSense account with HubPages, so that you can earn money from ads on your articles. No data is shared unless you engage with this feature. (Privacy Policy)
Google YouTubeSome articles have YouTube videos embedded in them. (Privacy Policy)
VimeoSome articles have Vimeo videos embedded in them. (Privacy Policy)
PaypalThis is used for a registered author who enrolls in the HubPages Earnings program and requests to be paid via PayPal. No data is shared with Paypal unless you engage with this feature. (Privacy Policy)
Facebook LoginYou can use this to streamline signing up for, or signing in to your Hubpages account. No data is shared with Facebook unless you engage with this feature. (Privacy Policy)
MavenThis supports the Maven widget and search functionality. (Privacy Policy)
Google AdSenseThis is an ad network. (Privacy Policy)
Google DoubleClickGoogle provides ad serving technology and runs an ad network. (Privacy Policy)
Index ExchangeThis is an ad network. (Privacy Policy)
SovrnThis is an ad network. (Privacy Policy)
Facebook AdsThis is an ad network. (Privacy Policy)
Amazon Unified Ad MarketplaceThis is an ad network. (Privacy Policy)
AppNexusThis is an ad network. (Privacy Policy)
OpenxThis is an ad network. (Privacy Policy)
Rubicon ProjectThis is an ad network. (Privacy Policy)
TripleLiftThis is an ad network. (Privacy Policy)
Say MediaWe partner with Say Media to deliver ad campaigns on our sites. (Privacy Policy)
Remarketing PixelsWe may use remarketing pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to advertise the HubPages Service to people that have visited our sites.
Conversion Tracking PixelsWe may use conversion tracking pixels from advertising networks such as Google AdWords, Bing Ads, and Facebook in order to identify when an advertisement has successfully resulted in the desired action, such as signing up for the HubPages Service or publishing an article on the HubPages Service.
Author Google AnalyticsThis is used to provide traffic data and reports to the authors of articles on the HubPages Service. (Privacy Policy)
ComscoreComScore is a media measurement and analytics company providing marketing data and analytics to enterprises, media and advertising agencies, and publishers. Non-consent will result in ComScore only processing obfuscated personal data. (Privacy Policy)
Amazon Tracking PixelSome articles display amazon products as part of the Amazon Affiliate program, this pixel provides traffic statistics for those products (Privacy Policy)
ClickscoThis is a data management platform studying reader behavior (Privacy Policy)