SlideShare a Scribd company logo
Top 10 Tips to Increase
Usability of User Documentation




                   Christi Thompson
Usability
 Definition: The extent to which a product can be used
 by specified users to achieve specified goals with
 effectiveness, efficiency, and satisfaction in a specified
 context of use.       -Human Factors International
 Effectiveness
 Eff
 Ease of learning
 Efficiency of use
 Memorability
 Error prevention
 Satisfaction

 Think PINC
1. Start at the Top:
    Know the Business Goals
    K       h B i     G l

 Usability goals vs business goals
 Is everyone on the same page?
 Prioritize accordingly
 Measure your end results according to
 M                 d     l         di
 the business goals.
2.
2 Create a Persona
 Persona: A concrete characterization of a single user group
 through a synthesis of th user, t k and environment profiles of
 th     h       th i f the        task, d       i       t    fil  f
 that group. It provides a detailed example of the potential end user
 that represents a specific target audience type. Personas help you
 think in terms of users by p
                           y providing insight into how they might use
                                     g     g               y g
 the product.

 User, Task, and Environment Profiles
     ,     ,

 Paula Grey, Professional Staff Member, Senate Agriculture
 Committee, 42 years old, Divorced, 1 child, Law degree,Very
                 y                                  g       y
 comfortable using a computer, intermediate internet user, with
 high-speed connection at work and DSL at home for daughter.
 Uses application extensively.
3. Match Documentation to the
User’s World
U ’ W ld
   Schema: Essentially a packet of information
   in the human memory based on knowledge
   and experience.

   Use real world conventions and put things
   in
   i a natural, l i l order.
             l logical d

   Speak the user’s language.
4. Understand the Programmer’s vs.
User’s P i
U ’ Point of View
             f Vi
 The developer can explain the screens and how
 they interact. The user brings to the program a
 conceptual schema of how it works. These must
 be in
 b i sync.

 Don’t just d
 D ’ j document how the program should
                       h     h             h ld
 work in a perfect world. Figure out the
 obstacles users face and the strategies they use
 to accomplish the goal.
5. Think BIGGER:
What is the User’s Question?
Wh i h U ’ Q            i ?

 What is the more complex problem?

 Users rarely ask, “How do I use this menu
 option?” Instead, they ask, “ How do I move this
 block of stuff over there?”

 Start with the real questions and work from
 there.
6. Expect Errors
6
 Provide troubleshooting and special cases
 assistance.
 When analyzing tasks, don’t approach it from an
 error-free (developer’s) perspective. Focus on
 where errors are most likely to occur.
 Incorporate this information within the process
 where it occurs.
 Use examples The best ones include special
      examples.
 cases in addition to the normal issues.
7. Consistent Consistency
7
 Terminology should be consistent on the
             gy
 interface, labels on entry fields, error
 messages, guides, help, all documentation.
        g g            p

 Ideally,
 Ideally match the user persona s
                        persona’s
 vocabulary or go with the commonly
 accepted standard
           standard.
8. Choose the Appropriate Media
and Optimize
   dO i i

 Use your environment profile to
 determine the best final format.
  ete    et e          a o at.

 Print vs. Online:Valuable screen real
       vs
 estate may cause a preference for printed
 guides.
 guides
9.
9 Do a Usability Test

 Human Help
 Index
 Summary
 Procedural
 P     d l
 Discovery
10. Measure the Results Against
the Business Goals
 h B i       G l

 Collect measurable results.
 Engineer the content for your audience. If the
 executive is interested in financial benefits, use a
 return on investment calculation to report how
 training and time spent on support calls was
    i i      d i                          ll
 saved. If conversion and satisfaction is
 important,
 important report usage and satisfaction results
                                             results.
We are Information Developers
 We are not documenting simple
                        g      p
 procedures. We are assisting in complex
 p
 problem solving.
               g

 It helps if people know about F1
                               F1.
The End!
            Christi Thompson, CUA
                        p
    Technical Communicator, CORPTAX, Inc.
          chrthompson@corptax.com
          chrthompson@corptax com

                THANK YOU
.

More Related Content

PDF
MVP of visualization and analytics
PDF
Hands-on data consulting with jamovi
PPTX
Приемы эффективной разработки документации к ПО и техническим системам
PPTX
Rapid development of help files and user documentation in Dr.Explain 5
PPTX
Targeted documentation STC Houston, Mar 20, 2012
PDF
By the Book: How Great User Experiences in Software Can Impact Government and...
PDF
User Experience Design Fundamentals - Part 1: Users & Goals
PPTX
Targeted documentation
MVP of visualization and analytics
Hands-on data consulting with jamovi
Приемы эффективной разработки документации к ПО и техническим системам
Rapid development of help files and user documentation in Dr.Explain 5
Targeted documentation STC Houston, Mar 20, 2012
By the Book: How Great User Experiences in Software Can Impact Government and...
User Experience Design Fundamentals - Part 1: Users & Goals
Targeted documentation

Similar to C:\Documents And Settings\Deanne\My Documents\Stc Stuff\From Other Stc Chapters\Top10 Usability Tips (20)

PDF
Evaluating Usability Of Commercial Software Applications
PPTX
Things you should know before you build your site
PDF
Visual Modeling Within UCD (English)
PDF
Achieving A Great User Experience For Enterprise Software
PPT
Bake UX into your Startup (March 2009)
PDF
How to define UX objectives and goals using a "lean" six sigma approach
PDF
Getting Started With User Research, Presented at Agile2010
PDF
The elements of product success for designers and developers
PDF
It Role State Exploration 7 Nov Illumine
PDF
UX is for Losers
PPTX
World Usability Day 2014 - Keene State College - Usable Documentation - Kevin...
PDF
P-Camp 2008 - PM & UX - Meghan Ede 2
PPTX
Selling UX at CodeMash 2012
PDF
User experience design for large enterprise applications
PDF
Tale of two customers: Addressing the struggle between flexibility and usabil...
PPTX
Teaching UX to Your Team
PPT
Selling Usability Into Organizations
PPT
Best Practice Information Architecture
PPTX
User experience & design user centered analysis
PDF
Agile 10 Step Story Model
Evaluating Usability Of Commercial Software Applications
Things you should know before you build your site
Visual Modeling Within UCD (English)
Achieving A Great User Experience For Enterprise Software
Bake UX into your Startup (March 2009)
How to define UX objectives and goals using a "lean" six sigma approach
Getting Started With User Research, Presented at Agile2010
The elements of product success for designers and developers
It Role State Exploration 7 Nov Illumine
UX is for Losers
World Usability Day 2014 - Keene State College - Usable Documentation - Kevin...
P-Camp 2008 - PM & UX - Meghan Ede 2
Selling UX at CodeMash 2012
User experience design for large enterprise applications
Tale of two customers: Addressing the struggle between flexibility and usabil...
Teaching UX to Your Team
Selling Usability Into Organizations
Best Practice Information Architecture
User experience & design user centered analysis
Agile 10 Step Story Model
Ad

Recently uploaded (20)

PPTX
MYSQL Presentation for SQL database connectivity
PDF
The Rise and Fall of 3GPP – Time for a Sabbatical?
PPTX
Big Data Technologies - Introduction.pptx
PPTX
1. Introduction to Computer Programming.pptx
PDF
gpt5_lecture_notes_comprehensive_20250812015547.pdf
PPTX
Programs and apps: productivity, graphics, security and other tools
PDF
Reach Out and Touch Someone: Haptics and Empathic Computing
PDF
MIND Revenue Release Quarter 2 2025 Press Release
PDF
cuic standard and advanced reporting.pdf
PPT
“AI and Expert System Decision Support & Business Intelligence Systems”
PPTX
Machine Learning_overview_presentation.pptx
PDF
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
PDF
Dropbox Q2 2025 Financial Results & Investor Presentation
PDF
Video forgery: An extensive analysis of inter-and intra-frame manipulation al...
PDF
Encapsulation_ Review paper, used for researhc scholars
PDF
Blue Purple Modern Animated Computer Science Presentation.pdf.pdf
PDF
Advanced methodologies resolving dimensionality complications for autism neur...
PDF
Network Security Unit 5.pdf for BCA BBA.
PDF
Accuracy of neural networks in brain wave diagnosis of schizophrenia
PDF
7 ChatGPT Prompts to Help You Define Your Ideal Customer Profile.pdf
MYSQL Presentation for SQL database connectivity
The Rise and Fall of 3GPP – Time for a Sabbatical?
Big Data Technologies - Introduction.pptx
1. Introduction to Computer Programming.pptx
gpt5_lecture_notes_comprehensive_20250812015547.pdf
Programs and apps: productivity, graphics, security and other tools
Reach Out and Touch Someone: Haptics and Empathic Computing
MIND Revenue Release Quarter 2 2025 Press Release
cuic standard and advanced reporting.pdf
“AI and Expert System Decision Support & Business Intelligence Systems”
Machine Learning_overview_presentation.pptx
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
Dropbox Q2 2025 Financial Results & Investor Presentation
Video forgery: An extensive analysis of inter-and intra-frame manipulation al...
Encapsulation_ Review paper, used for researhc scholars
Blue Purple Modern Animated Computer Science Presentation.pdf.pdf
Advanced methodologies resolving dimensionality complications for autism neur...
Network Security Unit 5.pdf for BCA BBA.
Accuracy of neural networks in brain wave diagnosis of schizophrenia
7 ChatGPT Prompts to Help You Define Your Ideal Customer Profile.pdf
Ad

C:\Documents And Settings\Deanne\My Documents\Stc Stuff\From Other Stc Chapters\Top10 Usability Tips

  • 1. Top 10 Tips to Increase Usability of User Documentation Christi Thompson
  • 2. Usability Definition: The extent to which a product can be used by specified users to achieve specified goals with effectiveness, efficiency, and satisfaction in a specified context of use. -Human Factors International Effectiveness Eff Ease of learning Efficiency of use Memorability Error prevention Satisfaction Think PINC
  • 3. 1. Start at the Top: Know the Business Goals K h B i G l Usability goals vs business goals Is everyone on the same page? Prioritize accordingly Measure your end results according to M d l di the business goals.
  • 4. 2. 2 Create a Persona Persona: A concrete characterization of a single user group through a synthesis of th user, t k and environment profiles of th h th i f the task, d i t fil f that group. It provides a detailed example of the potential end user that represents a specific target audience type. Personas help you think in terms of users by p y providing insight into how they might use g g y g the product. User, Task, and Environment Profiles , , Paula Grey, Professional Staff Member, Senate Agriculture Committee, 42 years old, Divorced, 1 child, Law degree,Very y g y comfortable using a computer, intermediate internet user, with high-speed connection at work and DSL at home for daughter. Uses application extensively.
  • 5. 3. Match Documentation to the User’s World U ’ W ld Schema: Essentially a packet of information in the human memory based on knowledge and experience. Use real world conventions and put things in i a natural, l i l order. l logical d Speak the user’s language.
  • 6. 4. Understand the Programmer’s vs. User’s P i U ’ Point of View f Vi The developer can explain the screens and how they interact. The user brings to the program a conceptual schema of how it works. These must be in b i sync. Don’t just d D ’ j document how the program should h h h ld work in a perfect world. Figure out the obstacles users face and the strategies they use to accomplish the goal.
  • 7. 5. Think BIGGER: What is the User’s Question? Wh i h U ’ Q i ? What is the more complex problem? Users rarely ask, “How do I use this menu option?” Instead, they ask, “ How do I move this block of stuff over there?” Start with the real questions and work from there.
  • 8. 6. Expect Errors 6 Provide troubleshooting and special cases assistance. When analyzing tasks, don’t approach it from an error-free (developer’s) perspective. Focus on where errors are most likely to occur. Incorporate this information within the process where it occurs. Use examples The best ones include special examples. cases in addition to the normal issues.
  • 9. 7. Consistent Consistency 7 Terminology should be consistent on the gy interface, labels on entry fields, error messages, guides, help, all documentation. g g p Ideally, Ideally match the user persona s persona’s vocabulary or go with the commonly accepted standard standard.
  • 10. 8. Choose the Appropriate Media and Optimize dO i i Use your environment profile to determine the best final format. ete et e a o at. Print vs. Online:Valuable screen real vs estate may cause a preference for printed guides. guides
  • 11. 9. 9 Do a Usability Test Human Help Index Summary Procedural P d l Discovery
  • 12. 10. Measure the Results Against the Business Goals h B i G l Collect measurable results. Engineer the content for your audience. If the executive is interested in financial benefits, use a return on investment calculation to report how training and time spent on support calls was i i d i ll saved. If conversion and satisfaction is important, important report usage and satisfaction results results.
  • 13. We are Information Developers We are not documenting simple g p procedures. We are assisting in complex p problem solving. g It helps if people know about F1 F1.
  • 14. The End! Christi Thompson, CUA p Technical Communicator, CORPTAX, Inc. chrthompson@corptax.com chrthompson@corptax com THANK YOU .