SlideShare a Scribd company logo
1 of 12
Download to read offline
WRITING, CLEAR   AND   SIMPLE


DOCUMENT TESTING:
 THE MISSING STEP

       BY ROY JACOBSEN




                                   1/12
Y      ou know what a document needs to do.You’ve analyzed the
                         audience demographics and anticipated the needs of various
                         types of likely readers. Or you’ve created a profile of the
                  typical targeted reader. Whether the goal is to educate, inform,
                  motivate, entertain, influence thinking, inspire a specific response,
                  or a combination of these, the intended takeaway is clear.

You can’t be      So you map out the resources, gather data, interview subject matter
                  experts, and review the appropriate journals and other reference
confident a       works.You create an outline, then write several drafts.You choose
                  your words carefully, then proofread the final draft yourself before it
document will     is reviewed and revised to adhere to your in-house style guide and
meet its goals    receives the approval of the powers that be, perhaps including the
                  legal department.
unless you take
                  In sum, you do everything you know how to do so this document—
one final step:   it may be a letter, brochure, pamphlet, or manual—meets all
                  requirements for attaining the goal that you or your organization set
testing.          for it, and serves its external audience well.

                  But you can’t be confident a document will fulfill these expectations
                  unless you take one final step: testing.




                                                                                     2/12
WHY TESTING?
The primary goal of document testing is pretty clear—make sure
the document achieves its main goals— but there are a number of
ancillary benefits as well:

   ●   Reduce customer service calls: By testing your document’s
       effectiveness, and then modifying it based on that testing, you
       reduce the likelihood that customers will have to call to ask
       questions.
   ●   Increase audience/customer satisfaction: If your document
       clearly communicates its message to the audience, they’re
       likely to have a better impression of your organization than
       they would have if it left them puzzled.
   ●   Prevent costly rewriting and reprinting. It’s far better to
       discover fundamental flaws in your document before you go
       to the time and expense of printing and distributing it.


DOCUMENT TESTING METHODS
You can use several different methods to test a document; the one
you choose will depend on the type of data you want to gather
(qualitative or quantitative), the type of document you’re producing,
and your publishing context.

                                                                   3/12
●   Protocol testing
       ●   Focus groups
       ●   Usability testing
       ●   Control studies

    The first three methods are qualitative and will help you observe and
    gather reader reactions; the fourth is quantitative and will produce
    data about the accessibility of a document.


Whichever method you choose, tie the test design to
the document’s goal.

    For example, if it’s an educational, informative document, you’ll test
    for how well readers understand the information. If you want your
    readers to take some action in response to the document, you’re
    testing for the correct specific response.

    Protocol testing is one of the easiest and least expensive
    qualitative testing methods. It involves one-on-one interviews with
    readers from your target audience and helps show whether they
    really understand what the document is supposed to tell them. In a
    protocol test, after reading a portion of the text—usually a few

                                                                      4/12
sentences—a reader is asked by an interviewer to explain what that
    portion means. After allowing a reader to finish the document, the
    interviewer can ask broader questions, can be asked such as “What
    do you think is the main point of this document?” “What would you
    do after reading this document?”


Protocol testing has been widely used in plain-
language initiatives to test readability.

    It can reveal confusing word choices, missing information, or
    ambiguous instructions. For example, while testing some of its form
    letters in 2006, the U.S. Veterans Benefits Administration discovered
    that different readers gave strikingly different definitions for terms
    like gainfully employed and service-connected disability. More important,
    the readers’ definitions frequently did not match the VBA’s.

    You don’t need to conduct a large number of these interviews to get
    useful feedback on a document. Six to nine participants is a good
    group, although you can benefit by interviewing as few as three
    readers, according to the plainlanguage.gov testing guidelines and
    usability guru Jakob Nielsen (useit.com).



                                                                         5/12
Focus groups also gather qualitative information, primarily about
                   how people feel about a document. A moderator works with a small
                   group—usually 8 to 12 people— selected from the target audience.
                   Ideally, the moderator will be neutral—someone not involved in
                   creating the document.

If your document   The moderator will prepare a number of questions about the
                   document under review and guide the group through a discussion of
is intended to     their answers. The questions should not be leading or potentially
                   biased toward a particular response.
influence
                   If your document is intended to influence readers, a focus group can
readers, a focus   help you gauge its effectiveness. However, for identifying usability
group can help     problems and measuring readers’ understanding of the content, a
                   focus group is not the best method.
you gauge its
                   Usability testing involves watching how a reader attempts to use a
effectiveness.     document and follow instructions. This qualitative approach is well
                   suited to instructional documents.

                   For example, you might watch someone try to fill out a form or
                   assemble a product using the instructions you provided. As reference
                   points, you can give them a series of questions that you believe they



                                                                                    6/12
should be able to answer using the document—an open-book test,
    more or less.

    Do the users make any mistakes? Do they have to turn to other
    pages or other references for more information? Do they become
    lost or frustrated?


Asking readers to “think out loud” during usability
testing can give you insights into the way they process
the information in the document, the workarounds
they attempt, and their ultimate reaction to problems
they encounter.

    If you’re using any of these qualitative tests on large documents, it
    might be impractical to test the entire document. In that case, you’ll
    have to select sections that are representative of the whole, and
    apply what you learn from these parts to the whole.

    Control studies provide quantitative data about how well a
    document serves the goal set for it. In a control study, two versions
    of a document—a control (an original version) and a test version
    that has been revised in some way—are distributed to test groups.

                                                                      7/12
The respective groups’ responses are measured and can be compared
                     to see which version was more effective.

Which would          For example, you can test which version of a brochure results in
                     greater enrollment in a program, or leads to fewer recipients calling
you rather deal      a help line with questions. Direct marketers use control studies to
with: a bit of       test which sales letter is most effective with prospects.

preproduction        Control testing can tell you not only which document is more
                     effective but also how much more effective it is. What this test does
testing or a flood   not tell you is why one version is more effective. That has to be
                     deduced; for that, you’ll need to use one of the qualitative methods.
of calls from        Further control testing can then validate any changes you decide to
angry customers?     make on the basis of the qualitative testing.

                     TEST WHEN IT MAKES SENSE TO
                     Not every document you create will merit testing, of course—even
                     if there were world enough and time, not to mention the funds.
                     You’ll make the decision to test, based on a few factors. Ask yourself
                     these two questions:

                        ●   How many people potentially will read this document?
                        ●   If they have trouble understanding or using the information,
                            what’s the worst that can happen?

                                                                                       8/12
A letter going to a few customers may not be worth testing. But if
thousands of insurance customers will receive a brochure or e-mail
that explains important renewal policy changes, you may want to
test the text and compare formatting alternatives during
development. The point of testing is to fine-tune a high-visibility,
highimpact message so it has the greatest possible impact.

Which would you rather deal with: a bit of preproduction testing or
a flood of calls from angry customers? It’s best to hear from
frustrated test-users while there’s still time to make adjustments.
And if you’ve made a critical factual error, missed an ambiguous
instruction, or underestimated the complexity of your message, the
investment in testing can save you the expense of revising and
reprinting a corrected document. Testing now also can protect your
credibility and reputation later—an expense it’s hard to measure,
but a real one.




                                                                  9/12
RESOURCES
Here are a few resources that can help you with document testing:

TestingYour Documents (plainlanguage.gov/howto/guidelines/bigdoc/
testing.cfm). This article from plainlanguage.gov describes some of
the types of tests recommended by the plain language initiatives in
the U.S. Federal Government.

The Usability Methods Toolbox (jthom.best.vwh.net/usability/). This
website, compiled by James Hom, brings together information
about several different usability testing methods.

The Plain Language Association International website
(plainlanguagenetwork.org) includes several articles that discuss
document testing. This Google search lists most of them:
google.com/search?q=testing+site:plainlanguagenetwork.org

Don’t Make Me Think: A Common Sense Approach toWeb Usability by Steve
Krug (2000, New Riders Publishing). Although it’s about testing
websites, this book’s guidelines can help you plan document usability
testing.




                                                                    10/12
ABOUT THE AUTHOR
Roy Jacobsen is a writer, editor, speaker, and writing coach. He has
more than 20 years of experience writing and editing in a number of
fields, including the health food industry, agricultural economics
research, and computer software.

You can download this article, and other articles at his website,
Writing, Clear and Simple. Go to rmjacobsen.squarespace.com, and
click Articles on the sidebar.

Jacobsen lives in Fargo, North Dakota.

PUBLICATION DATE
This document was created on 29 October 2008.

This work was originally printed in The Editorial Eye, 66 Canal
Center Plaza, Suite 200, Alexandria, VA 22314-5507, (703)
683-0683.




                                                                  11/12
COPYRIGHT
The copyright of this work belongs to Roy Jacobsen.

This work is licensed under the Creative Commons Attribution-
Noncommercial-No Derivative Works 3.0 United States License. To
view a copy of this license, visit
http://creativecommons.org/licenses/by-nc-nd/3.0/us/ or send a
letter to Creative Commons, 171 Second Street, Suite 300, San
Francisco, California, 94105, USA.


WHAT DOES THAT MEAN?
That means you are free to give copies of this file to your family,
friends, co-workers, and perfect strangers.You can send them via e-
mail or distribute them on your website.You can print it out and
give copies away in your office, in your neighborhood, or on the
street corner.You may not change this document in any way, or
charge a fee for it.




                                                               12/12

More Related Content

Similar to Document Testing: The Missing Step to Ensure Clarity

Kaplan University Writing Center Resource Library  Case.docx
Kaplan University Writing Center Resource Library      Case.docxKaplan University Writing Center Resource Library      Case.docx
Kaplan University Writing Center Resource Library  Case.docxDIPESH30
 
Uxpin guide to_usability_testing
Uxpin guide to_usability_testingUxpin guide to_usability_testing
Uxpin guide to_usability_testingimdurgesh
 
SURVEY TUTORIAL
SURVEY TUTORIALSURVEY TUTORIAL
SURVEY TUTORIALHanen Mhz
 
Eapp Evaluation
Eapp EvaluationEapp Evaluation
Eapp EvaluationPGAEAPP
 
Healthcare Health Literacy.pdf
Healthcare Health Literacy.pdfHealthcare Health Literacy.pdf
Healthcare Health Literacy.pdfsdfghj21
 
Carma internet research module: Survey reduction
Carma internet research module: Survey reductionCarma internet research module: Survey reduction
Carma internet research module: Survey reductionSyracuse University
 
1) A cyber crime is a crime that involves a computer and the Inter.docx
1) A cyber crime is a crime that involves a computer and the Inter.docx1) A cyber crime is a crime that involves a computer and the Inter.docx
1) A cyber crime is a crime that involves a computer and the Inter.docxSONU61709
 
How to design questionnaire
How to design questionnaireHow to design questionnaire
How to design questionnairesukesh gowda
 
Strategic Review Jan 10
Strategic Review Jan 10Strategic Review Jan 10
Strategic Review Jan 10gpcuppan
 
Responses to Other Students Respond to at least 2 of your fellow .docx
Responses to Other Students Respond to at least 2 of your fellow .docxResponses to Other Students Respond to at least 2 of your fellow .docx
Responses to Other Students Respond to at least 2 of your fellow .docxronak56
 
Creative Media BTEC- "Unit 3- Research Techniques"
Creative Media BTEC- "Unit 3- Research Techniques"Creative Media BTEC- "Unit 3- Research Techniques"
Creative Media BTEC- "Unit 3- Research Techniques"Brandon Boyd
 
Modules module5mod5home.htmlmodule 5 homecomparing models
Modules module5mod5home.htmlmodule 5   homecomparing modelsModules module5mod5home.htmlmodule 5   homecomparing models
Modules module5mod5home.htmlmodule 5 homecomparing modelsPOLY33
 
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721e
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721eHow to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721e
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721eKæsy Chaudhari
 
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docx
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docxWK 2 DQ 1Read the journal article The Ethics of Internet Resear.docx
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docxambersalomon88660
 

Similar to Document Testing: The Missing Step to Ensure Clarity (19)

Kaplan University Writing Center Resource Library  Case.docx
Kaplan University Writing Center Resource Library      Case.docxKaplan University Writing Center Resource Library      Case.docx
Kaplan University Writing Center Resource Library  Case.docx
 
Uxpin guide to_usability_testing
Uxpin guide to_usability_testingUxpin guide to_usability_testing
Uxpin guide to_usability_testing
 
SURVEY TUTORIAL
SURVEY TUTORIALSURVEY TUTORIAL
SURVEY TUTORIAL
 
Eapp Evaluation
Eapp EvaluationEapp Evaluation
Eapp Evaluation
 
Campus Session 2
Campus Session 2Campus Session 2
Campus Session 2
 
Using Standardized Instruments
Using Standardized InstrumentsUsing Standardized Instruments
Using Standardized Instruments
 
Handout #1 - QIAMay4
Handout #1 - QIAMay4 Handout #1 - QIAMay4
Handout #1 - QIAMay4
 
High Quality Essays
High Quality EssaysHigh Quality Essays
High Quality Essays
 
Healthcare Health Literacy.pdf
Healthcare Health Literacy.pdfHealthcare Health Literacy.pdf
Healthcare Health Literacy.pdf
 
Carma internet research module: Survey reduction
Carma internet research module: Survey reductionCarma internet research module: Survey reduction
Carma internet research module: Survey reduction
 
1) A cyber crime is a crime that involves a computer and the Inter.docx
1) A cyber crime is a crime that involves a computer and the Inter.docx1) A cyber crime is a crime that involves a computer and the Inter.docx
1) A cyber crime is a crime that involves a computer and the Inter.docx
 
How to design questionnaire
How to design questionnaireHow to design questionnaire
How to design questionnaire
 
Strategic Review Jan 10
Strategic Review Jan 10Strategic Review Jan 10
Strategic Review Jan 10
 
Responses to Other Students Respond to at least 2 of your fellow .docx
Responses to Other Students Respond to at least 2 of your fellow .docxResponses to Other Students Respond to at least 2 of your fellow .docx
Responses to Other Students Respond to at least 2 of your fellow .docx
 
Creative Media BTEC- "Unit 3- Research Techniques"
Creative Media BTEC- "Unit 3- Research Techniques"Creative Media BTEC- "Unit 3- Research Techniques"
Creative Media BTEC- "Unit 3- Research Techniques"
 
Modules module5mod5home.htmlmodule 5 homecomparing models
Modules module5mod5home.htmlmodule 5   homecomparing modelsModules module5mod5home.htmlmodule 5   homecomparing models
Modules module5mod5home.htmlmodule 5 homecomparing models
 
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721e
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721eHow to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721e
How to publish_paper_in_journal_a69e887c16ae8baa32e4a332eeb9721e
 
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docx
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docxWK 2 DQ 1Read the journal article The Ethics of Internet Resear.docx
WK 2 DQ 1Read the journal article The Ethics of Internet Resear.docx
 
Surveys
SurveysSurveys
Surveys
 

More from Scott Abel

The Future Of Technical Communication
The Future Of Technical CommunicationThe Future Of Technical Communication
The Future Of Technical CommunicationScott Abel
 
Move Over Text: Video Documentation Meets DITA
Move Over Text: Video Documentation Meets DITAMove Over Text: Video Documentation Meets DITA
Move Over Text: Video Documentation Meets DITAScott Abel
 
Twitter Who Cares What You\'re Doing Right Now, Anyway
Twitter Who Cares What You\'re Doing Right Now, AnywayTwitter Who Cares What You\'re Doing Right Now, Anyway
Twitter Who Cares What You\'re Doing Right Now, AnywayScott Abel
 
Intelligent Contet Here And Now
Intelligent Contet Here And NowIntelligent Contet Here And Now
Intelligent Contet Here And NowScott Abel
 
Authoring and Publishing with XMetaL and DITA
Authoring and Publishing with XMetaL and DITAAuthoring and Publishing with XMetaL and DITA
Authoring and Publishing with XMetaL and DITAScott Abel
 
Comparing DITA Support in XMetaL and FrameMaker
Comparing DITA Support in XMetaL and FrameMakerComparing DITA Support in XMetaL and FrameMaker
Comparing DITA Support in XMetaL and FrameMakerScott Abel
 
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsSuccess Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsScott Abel
 
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...Scott Abel
 
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...Scott Abel
 
The Changing Face of TechComm and the Society for Technical Communication
The Changing Face of TechComm and the Society for Technical CommunicationThe Changing Face of TechComm and the Society for Technical Communication
The Changing Face of TechComm and the Society for Technical CommunicationScott Abel
 
The Truth about Content: Learning from the Past in order to Succeed in the Fu...
The Truth about Content: Learning from the Past in order to Succeed in the Fu...The Truth about Content: Learning from the Past in order to Succeed in the Fu...
The Truth about Content: Learning from the Past in order to Succeed in the Fu...Scott Abel
 
Content Oriented Architectures: Putting Content at the Center of CM Projects
Content Oriented Architectures: Putting Content at the Center of CM ProjectsContent Oriented Architectures: Putting Content at the Center of CM Projects
Content Oriented Architectures: Putting Content at the Center of CM ProjectsScott Abel
 
Modular Content Projects: One Size DOES NOT Fit All
Modular Content Projects: One Size DOES NOT Fit AllModular Content Projects: One Size DOES NOT Fit All
Modular Content Projects: One Size DOES NOT Fit AllScott Abel
 
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...Scott Abel
 
Theory of Constraints and Project Management: Challenging the Dominant Paradigm
Theory of Constraints and Project Management: Challenging the Dominant ParadigmTheory of Constraints and Project Management: Challenging the Dominant Paradigm
Theory of Constraints and Project Management: Challenging the Dominant ParadigmScott Abel
 
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why'sScott Abel
 
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...Scott Abel
 
Sustainable XML for Publishing Applications: DITA Makes It Possible
Sustainable XML for Publishing Applications: DITA Makes It PossibleSustainable XML for Publishing Applications: DITA Makes It Possible
Sustainable XML for Publishing Applications: DITA Makes It PossibleScott Abel
 
Keynote: The Next Generation Home Digital Experience
Keynote: The Next Generation Home Digital ExperienceKeynote: The Next Generation Home Digital Experience
Keynote: The Next Generation Home Digital ExperienceScott Abel
 

More from Scott Abel (20)

The Future Of Technical Communication
The Future Of Technical CommunicationThe Future Of Technical Communication
The Future Of Technical Communication
 
Move Over Text: Video Documentation Meets DITA
Move Over Text: Video Documentation Meets DITAMove Over Text: Video Documentation Meets DITA
Move Over Text: Video Documentation Meets DITA
 
Twitter Who Cares What You\'re Doing Right Now, Anyway
Twitter Who Cares What You\'re Doing Right Now, AnywayTwitter Who Cares What You\'re Doing Right Now, Anyway
Twitter Who Cares What You\'re Doing Right Now, Anyway
 
Intelligent Contet Here And Now
Intelligent Contet Here And NowIntelligent Contet Here And Now
Intelligent Contet Here And Now
 
Authoring and Publishing with XMetaL and DITA
Authoring and Publishing with XMetaL and DITAAuthoring and Publishing with XMetaL and DITA
Authoring and Publishing with XMetaL and DITA
 
Comparing DITA Support in XMetaL and FrameMaker
Comparing DITA Support in XMetaL and FrameMakerComparing DITA Support in XMetaL and FrameMaker
Comparing DITA Support in XMetaL and FrameMaker
 
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and FundamentalsSuccess Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
Success Factors for DITA Adoption with XMetaL: Best Practices and Fundamentals
 
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...
Blogzilla: Why Blogs Are The Monster In The Business Closet: You Are No Longe...
 
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...
Controlled Authoring Workshop: Learn How Standardizing Content Will Improve Q...
 
The Changing Face of TechComm and the Society for Technical Communication
The Changing Face of TechComm and the Society for Technical CommunicationThe Changing Face of TechComm and the Society for Technical Communication
The Changing Face of TechComm and the Society for Technical Communication
 
The Truth about Content: Learning from the Past in order to Succeed in the Fu...
The Truth about Content: Learning from the Past in order to Succeed in the Fu...The Truth about Content: Learning from the Past in order to Succeed in the Fu...
The Truth about Content: Learning from the Past in order to Succeed in the Fu...
 
Content Oriented Architectures: Putting Content at the Center of CM Projects
Content Oriented Architectures: Putting Content at the Center of CM ProjectsContent Oriented Architectures: Putting Content at the Center of CM Projects
Content Oriented Architectures: Putting Content at the Center of CM Projects
 
Modular Content Projects: One Size DOES NOT Fit All
Modular Content Projects: One Size DOES NOT Fit AllModular Content Projects: One Size DOES NOT Fit All
Modular Content Projects: One Size DOES NOT Fit All
 
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...
Navigating the Vendor Maze: Understanding XML Authoring Tools and Content Man...
 
It
ItIt
It
 
Theory of Constraints and Project Management: Challenging the Dominant Paradigm
Theory of Constraints and Project Management: Challenging the Dominant ParadigmTheory of Constraints and Project Management: Challenging the Dominant Paradigm
Theory of Constraints and Project Management: Challenging the Dominant Paradigm
 
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
[Case Study] - Nuclear Power, DITA and FrameMaker: The How's and Why's
 
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...
We Eat Our Own Dog Food: Three Companies in the World of Localization Technol...
 
Sustainable XML for Publishing Applications: DITA Makes It Possible
Sustainable XML for Publishing Applications: DITA Makes It PossibleSustainable XML for Publishing Applications: DITA Makes It Possible
Sustainable XML for Publishing Applications: DITA Makes It Possible
 
Keynote: The Next Generation Home Digital Experience
Keynote: The Next Generation Home Digital ExperienceKeynote: The Next Generation Home Digital Experience
Keynote: The Next Generation Home Digital Experience
 

Recently uploaded

A Deep Dive on Passkeys: FIDO Paris Seminar.pptx
A Deep Dive on Passkeys: FIDO Paris Seminar.pptxA Deep Dive on Passkeys: FIDO Paris Seminar.pptx
A Deep Dive on Passkeys: FIDO Paris Seminar.pptxLoriGlavin3
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr BaganFwdays
 
Moving Beyond Passwords: FIDO Paris Seminar.pdf
Moving Beyond Passwords: FIDO Paris Seminar.pdfMoving Beyond Passwords: FIDO Paris Seminar.pdf
Moving Beyond Passwords: FIDO Paris Seminar.pdfLoriGlavin3
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii SoldatenkoFwdays
 
DSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningDSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningLars Bell
 
Advanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionAdvanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionDilum Bandara
 
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada
 
Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Commit University
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024Lonnie McRorey
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 3652toLead Limited
 
DevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsDevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsSergiu Bodiu
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyAlfredo García Lavilla
 
unit 4 immunoblotting technique complete.pptx
unit 4 immunoblotting technique complete.pptxunit 4 immunoblotting technique complete.pptx
unit 4 immunoblotting technique complete.pptxBkGupta21
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxNavinnSomaal
 
How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.Curtis Poe
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupFlorian Wilhelm
 
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024BookNet Canada
 
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek SchlawackFwdays
 
From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .Alan Dix
 

Recently uploaded (20)

A Deep Dive on Passkeys: FIDO Paris Seminar.pptx
A Deep Dive on Passkeys: FIDO Paris Seminar.pptxA Deep Dive on Passkeys: FIDO Paris Seminar.pptx
A Deep Dive on Passkeys: FIDO Paris Seminar.pptx
 
"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan"ML in Production",Oleksandr Bagan
"ML in Production",Oleksandr Bagan
 
Moving Beyond Passwords: FIDO Paris Seminar.pdf
Moving Beyond Passwords: FIDO Paris Seminar.pdfMoving Beyond Passwords: FIDO Paris Seminar.pdf
Moving Beyond Passwords: FIDO Paris Seminar.pdf
 
"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko"Debugging python applications inside k8s environment", Andrii Soldatenko
"Debugging python applications inside k8s environment", Andrii Soldatenko
 
DSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine TuningDSPy a system for AI to Write Prompts and Do Fine Tuning
DSPy a system for AI to Write Prompts and Do Fine Tuning
 
DMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special EditionDMCC Future of Trade Web3 - Special Edition
DMCC Future of Trade Web3 - Special Edition
 
Advanced Computer Architecture – An Introduction
Advanced Computer Architecture – An IntroductionAdvanced Computer Architecture – An Introduction
Advanced Computer Architecture – An Introduction
 
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
 
Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!Nell’iperspazio con Rocket: il Framework Web di Rust!
Nell’iperspazio con Rocket: il Framework Web di Rust!
 
TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024TeamStation AI System Report LATAM IT Salaries 2024
TeamStation AI System Report LATAM IT Salaries 2024
 
Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365Ensuring Technical Readiness For Copilot in Microsoft 365
Ensuring Technical Readiness For Copilot in Microsoft 365
 
DevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platformsDevEX - reference for building teams, processes, and platforms
DevEX - reference for building teams, processes, and platforms
 
Commit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easyCommit 2024 - Secret Management made easy
Commit 2024 - Secret Management made easy
 
unit 4 immunoblotting technique complete.pptx
unit 4 immunoblotting technique complete.pptxunit 4 immunoblotting technique complete.pptx
unit 4 immunoblotting technique complete.pptx
 
SAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptxSAP Build Work Zone - Overview L2-L3.pptx
SAP Build Work Zone - Overview L2-L3.pptx
 
How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.How AI, OpenAI, and ChatGPT impact business and software.
How AI, OpenAI, and ChatGPT impact business and software.
 
Streamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project SetupStreamlining Python Development: A Guide to a Modern Project Setup
Streamlining Python Development: A Guide to a Modern Project Setup
 
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
Transcript: New from BookNet Canada for 2024: Loan Stars - Tech Forum 2024
 
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
"Subclassing and Composition – A Pythonic Tour of Trade-Offs", Hynek Schlawack
 
From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .From Family Reminiscence to Scholarly Archive .
From Family Reminiscence to Scholarly Archive .
 

Document Testing: The Missing Step to Ensure Clarity

  • 1. WRITING, CLEAR AND SIMPLE DOCUMENT TESTING: THE MISSING STEP BY ROY JACOBSEN 1/12
  • 2. Y ou know what a document needs to do.You’ve analyzed the audience demographics and anticipated the needs of various types of likely readers. Or you’ve created a profile of the typical targeted reader. Whether the goal is to educate, inform, motivate, entertain, influence thinking, inspire a specific response, or a combination of these, the intended takeaway is clear. You can’t be So you map out the resources, gather data, interview subject matter experts, and review the appropriate journals and other reference confident a works.You create an outline, then write several drafts.You choose your words carefully, then proofread the final draft yourself before it document will is reviewed and revised to adhere to your in-house style guide and meet its goals receives the approval of the powers that be, perhaps including the legal department. unless you take In sum, you do everything you know how to do so this document— one final step: it may be a letter, brochure, pamphlet, or manual—meets all requirements for attaining the goal that you or your organization set testing. for it, and serves its external audience well. But you can’t be confident a document will fulfill these expectations unless you take one final step: testing. 2/12
  • 3. WHY TESTING? The primary goal of document testing is pretty clear—make sure the document achieves its main goals— but there are a number of ancillary benefits as well: ● Reduce customer service calls: By testing your document’s effectiveness, and then modifying it based on that testing, you reduce the likelihood that customers will have to call to ask questions. ● Increase audience/customer satisfaction: If your document clearly communicates its message to the audience, they’re likely to have a better impression of your organization than they would have if it left them puzzled. ● Prevent costly rewriting and reprinting. It’s far better to discover fundamental flaws in your document before you go to the time and expense of printing and distributing it. DOCUMENT TESTING METHODS You can use several different methods to test a document; the one you choose will depend on the type of data you want to gather (qualitative or quantitative), the type of document you’re producing, and your publishing context. 3/12
  • 4. Protocol testing ● Focus groups ● Usability testing ● Control studies The first three methods are qualitative and will help you observe and gather reader reactions; the fourth is quantitative and will produce data about the accessibility of a document. Whichever method you choose, tie the test design to the document’s goal. For example, if it’s an educational, informative document, you’ll test for how well readers understand the information. If you want your readers to take some action in response to the document, you’re testing for the correct specific response. Protocol testing is one of the easiest and least expensive qualitative testing methods. It involves one-on-one interviews with readers from your target audience and helps show whether they really understand what the document is supposed to tell them. In a protocol test, after reading a portion of the text—usually a few 4/12
  • 5. sentences—a reader is asked by an interviewer to explain what that portion means. After allowing a reader to finish the document, the interviewer can ask broader questions, can be asked such as “What do you think is the main point of this document?” “What would you do after reading this document?” Protocol testing has been widely used in plain- language initiatives to test readability. It can reveal confusing word choices, missing information, or ambiguous instructions. For example, while testing some of its form letters in 2006, the U.S. Veterans Benefits Administration discovered that different readers gave strikingly different definitions for terms like gainfully employed and service-connected disability. More important, the readers’ definitions frequently did not match the VBA’s. You don’t need to conduct a large number of these interviews to get useful feedback on a document. Six to nine participants is a good group, although you can benefit by interviewing as few as three readers, according to the plainlanguage.gov testing guidelines and usability guru Jakob Nielsen (useit.com). 5/12
  • 6. Focus groups also gather qualitative information, primarily about how people feel about a document. A moderator works with a small group—usually 8 to 12 people— selected from the target audience. Ideally, the moderator will be neutral—someone not involved in creating the document. If your document The moderator will prepare a number of questions about the document under review and guide the group through a discussion of is intended to their answers. The questions should not be leading or potentially biased toward a particular response. influence If your document is intended to influence readers, a focus group can readers, a focus help you gauge its effectiveness. However, for identifying usability group can help problems and measuring readers’ understanding of the content, a focus group is not the best method. you gauge its Usability testing involves watching how a reader attempts to use a effectiveness. document and follow instructions. This qualitative approach is well suited to instructional documents. For example, you might watch someone try to fill out a form or assemble a product using the instructions you provided. As reference points, you can give them a series of questions that you believe they 6/12
  • 7. should be able to answer using the document—an open-book test, more or less. Do the users make any mistakes? Do they have to turn to other pages or other references for more information? Do they become lost or frustrated? Asking readers to “think out loud” during usability testing can give you insights into the way they process the information in the document, the workarounds they attempt, and their ultimate reaction to problems they encounter. If you’re using any of these qualitative tests on large documents, it might be impractical to test the entire document. In that case, you’ll have to select sections that are representative of the whole, and apply what you learn from these parts to the whole. Control studies provide quantitative data about how well a document serves the goal set for it. In a control study, two versions of a document—a control (an original version) and a test version that has been revised in some way—are distributed to test groups. 7/12
  • 8. The respective groups’ responses are measured and can be compared to see which version was more effective. Which would For example, you can test which version of a brochure results in greater enrollment in a program, or leads to fewer recipients calling you rather deal a help line with questions. Direct marketers use control studies to with: a bit of test which sales letter is most effective with prospects. preproduction Control testing can tell you not only which document is more effective but also how much more effective it is. What this test does testing or a flood not tell you is why one version is more effective. That has to be deduced; for that, you’ll need to use one of the qualitative methods. of calls from Further control testing can then validate any changes you decide to angry customers? make on the basis of the qualitative testing. TEST WHEN IT MAKES SENSE TO Not every document you create will merit testing, of course—even if there were world enough and time, not to mention the funds. You’ll make the decision to test, based on a few factors. Ask yourself these two questions: ● How many people potentially will read this document? ● If they have trouble understanding or using the information, what’s the worst that can happen? 8/12
  • 9. A letter going to a few customers may not be worth testing. But if thousands of insurance customers will receive a brochure or e-mail that explains important renewal policy changes, you may want to test the text and compare formatting alternatives during development. The point of testing is to fine-tune a high-visibility, highimpact message so it has the greatest possible impact. Which would you rather deal with: a bit of preproduction testing or a flood of calls from angry customers? It’s best to hear from frustrated test-users while there’s still time to make adjustments. And if you’ve made a critical factual error, missed an ambiguous instruction, or underestimated the complexity of your message, the investment in testing can save you the expense of revising and reprinting a corrected document. Testing now also can protect your credibility and reputation later—an expense it’s hard to measure, but a real one. 9/12
  • 10. RESOURCES Here are a few resources that can help you with document testing: TestingYour Documents (plainlanguage.gov/howto/guidelines/bigdoc/ testing.cfm). This article from plainlanguage.gov describes some of the types of tests recommended by the plain language initiatives in the U.S. Federal Government. The Usability Methods Toolbox (jthom.best.vwh.net/usability/). This website, compiled by James Hom, brings together information about several different usability testing methods. The Plain Language Association International website (plainlanguagenetwork.org) includes several articles that discuss document testing. This Google search lists most of them: google.com/search?q=testing+site:plainlanguagenetwork.org Don’t Make Me Think: A Common Sense Approach toWeb Usability by Steve Krug (2000, New Riders Publishing). Although it’s about testing websites, this book’s guidelines can help you plan document usability testing. 10/12
  • 11. ABOUT THE AUTHOR Roy Jacobsen is a writer, editor, speaker, and writing coach. He has more than 20 years of experience writing and editing in a number of fields, including the health food industry, agricultural economics research, and computer software. You can download this article, and other articles at his website, Writing, Clear and Simple. Go to rmjacobsen.squarespace.com, and click Articles on the sidebar. Jacobsen lives in Fargo, North Dakota. PUBLICATION DATE This document was created on 29 October 2008. This work was originally printed in The Editorial Eye, 66 Canal Center Plaza, Suite 200, Alexandria, VA 22314-5507, (703) 683-0683. 11/12
  • 12. COPYRIGHT The copyright of this work belongs to Roy Jacobsen. This work is licensed under the Creative Commons Attribution- Noncommercial-No Derivative Works 3.0 United States License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-nd/3.0/us/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. WHAT DOES THAT MEAN? That means you are free to give copies of this file to your family, friends, co-workers, and perfect strangers.You can send them via e- mail or distribute them on your website.You can print it out and give copies away in your office, in your neighborhood, or on the street corner.You may not change this document in any way, or charge a fee for it. 12/12