Usability Testing is a Great Way to Understand if Your Technical Writing Works

Usability testing is one of the best ways of evaluating the quality of a document. A technical writer can use usability testing to ensure user-centered writing. Testing validates documentation by examining successful task completion, identifying any critical errors, determining the time it takes to complete a task, reader satisfaction using the document, and collecting recommendations for necessary improvements.

Usability testing is a great way to understand what works and what doesn’t work in a document.

The metrics defined and collected by the technical communicator will determine how to evaluate successful comprehension and task completion. These metrics are generally both qualitative and quantitative depending on how the information is collected and measured. Set up goals for data collection, metrics, and analysis before usability testing. Consider that documentation can be tested using a variety of delivery methods such as smartphones, tablets, computers, printed versions, web pages, etc. Ask yourself how will your end-user most likely use the document?

User observation can be collected using qualitative methods letting a test administrator see how a user will react to the instructions in the document. Are they struggling and need to scroll back and forth? When the tester provides feedback, are they reflecting this in their observations on your document? Each person who tests your document may, or may not, feel that a qualitative aspect is important.

A user’s reaction to document use is important because some users may stop using a document if they need to scroll or turn pages constantly. Others may not. Observation of a document tester is especially important if you are using only a single tester. The smaller the test group, the higher the risk that feedback can be myopic and not reflect all readers’ experiences.

A user’s reaction to document use is important.

Unfortunately, we don’t always have time or the resources to do usability testing depending on project size, project milestones, release dates, and type of technical documentation. Nevertheless, new technical writers and students should consider even single user basic testing scenarios when they can. Usability testing is a great way for new technical writers to understand what works and doesn’t work in their documents.

Large documentation projects may employ usability testing, especially if there is a lot at stake. Usability testing requires buy-in by management to be successful because of the allocation of resources and stakeholders. Not all management buys into usability testing. Unfortunately, most technical documentation projects are quickly written, updated, or reviewed by someone who may not be an editor, and the document goes out to the intended audience without testing. This isn’t a big deal on a small document but can lead to quality issues in large documents. The importance of testing does depend on the document, purpose, and intended update schedule if any.

One of the best ways to think about the value of usability testing is that you are doing a test run with readers to catch catastrophic issues. This is particularly useful with standard operating procedures (SOPs) or any step-by-step instructions for dangerous occupations, hazardous locations, or safety-related situations. Any document can benefit from usability testing, but technical writing failure is particularly visible with SOPs or instructions. This is critical in industries where a misunderstanding or misrepresentation of data and information can lead to catastrophic failure (loss of finances, loss of property, or loss of life).

To start testing, recruit a pool of participants that fit the profile audience of the readers you are writing for. This provides the best results. The usability testing participants, if possible, should perform the testing under the same conditions a reader would use the document. Even a single qualified participant can help identify any clarity issues a document has.

Recruit a pool of participants that fit the profile of the audience.

For students, new technical writers, or small businesses who decide usability testing is for them, I stress using a single reader to save money and time as long as the reader is similar to the intended audience. Only an organization can judge whether they need a large testing sample based on their own usability testing practices and the complexity of their document.

Whatever an organization decides to do with usability testing, remember it is a team effort with all stakeholders. No one works in a vacuum, especially technical writers. The testing process needs both management and the technical communicator’s buy-in to work. Students should use it in their work as often as they can until they get used to writing for a variety of audiences. Remember, if there is a team of technical writers and graphic artists that are designing a document, usability testing can save money by allowing any identified readability problems to be corrected quickly and efficiently before document release. Poorly written documents can reflect negatively on an organization, the technical writer, and ultimately can place a user at risk.

Start Your New Year with a Class in Advanced Technical Writing

Want to be a working writer or perhaps improve your writing for your job? The Advanced Technical writing class starts Monday, January 4th, 2021 at California State University Dominguez Hills. The course is completely online and students learn advanced technical writing techniques along with improving your writing skills. The class is hands-on as we work on putting together a portfolio while we learn. Portfolio pieces are an important aspect of applying for technical writing jobs to show a prospective employer your capabilities.

For this class, students may take it even if they have not completed the Intro course if they have some writing experience. The certificate at California State University Dominguez Hills consists of three courses. Check out the schedule page if you want to see the other classes. The entire program for the certificate is taught online (and will continue to be taught online). Find out more information on the CSUDH web site.

The technical writing certificate program is approved for funding through the Workforce Innovation and Opportunity Act (WIOA).

New Semester at CSUDH – Study Technical Writing!

The Advanced Tech writing class starts Tuesday May 26th, 2020. The course is completely online and I look forward to meeting all new students. For this class, I allow students to take it even if they have not completed the Intro course. We work on putting together a portfolio as well as learning advanced technical writing techniques. This program is approved for funding through the Workforce Innovation and Opportunity Act (WIOA). Find out more on the CSUDH link below. #csudh #technicalwriting #technical #documentation #technicalwriter #writing

CSUDH Program Link

Check out more information at: Technical Writing Courses & Schedule

Learn Technical Writing at CSUDH

Try Technical Writing by Taking the Advanced Tech writing Course at CSUDH

IMG_0720 Do you like to write and would love to do it for a living? Try technical writing. No need to be a ‘techie’ or scientific guru. With practice, you can find out how technical writing is a great tool in a writers tool box.

Students who want to take the Advanced Technical Communication course so they can get right to creating portfolio pieces (before they take the Introduction course) are welcome to do that. The class is immersive. I teach the Advanced course and we focus on creating a portfolio of pieces (which is normally requested by potential clients and employers) and are a great way to learn how to write even if you want writing as your secret weapon in your job. We write a lot.

Some of the things I cover in the advanced class include presentations, reports, proposals, and step-by-step instructions. Check out my FAQ page for answers to the most asked questions I get in the course. The class is totally online and you will come away with several portfolio pieces. I’ve had students get jobs before they finish the program.

For more detailed info, check out California State University Dominguez Hills’ web site at:

http://www4.csudh.edu/ceie/Technical-Writing/

Welcome to the New Year and check out classes at CSUDH

It’s a new year everyone and I wanted to take the time to wish everyone an exciting and fresh start. I’d also like everyone to know that a new semester at California State University Dominguez Hills starts next week on 1/12/15 and I will be teaching classes for the College of Extended & International Education.

If you are looking to kick off the new year with adding new skill sets in your writing, getting a certificate or just a refresher and would like to learn online instead of driving to a University then check out the classes offered in the completely online certificate program in Technical Communication at CSUDH.

I teach the Advanced Technical Communications course and the Information Design course where we work on portfolio pieces providing the student with samples to present to potential employers as well as practical learning experience. I’ve had the privilege of having both international students from other countries such as Russia and Japan to local SoCal students so please take a moment to check out our program.

CSUDHLu Kondor has worked in engineering and technical writing at major visual motion picture and visual effects studios with more than 25 years experience in the entertainment industry. She is a member of the Academy of Television Arts & Sciences, Society for Technical Communication, the Society of Children’s Book Writers & Illustrators, and Delta Mu Delta International Honor Society in Business. Lu holds a doctorate in business management and has taught as adjunct faculty at CSUDH since 2007.