Submit Search
Upload
Targeted documentation STC Houston, Mar 20, 2012
•
Download as PPTX, PDF
•
0 likes
•
479 views
S
STC_Houston
Follow
Alyssa Fox's presentation slides for the March 20, 2012 STC Houston program meeting.
Read less
Read more
Technology
Business
Report
Share
Report
Share
1 of 19
Download now
Recommended
Targeted documentation
Targeted documentation
Alyssa Fox
Integrating User Experience Design into the Product Lifecycle
Integrating User Experience Design into the Product Lifecycle
ICS
It's all about the (customer) experience
It's all about the (customer) experience
ICS
Usability & Agile Development
Usability & Agile Development
binuvt
062311 Sunset Peer To Peer Tele Collaboration Introduction
062311 Sunset Peer To Peer Tele Collaboration Introduction
jesunset8766
Guerilla Human Computer Interaction and Customer Based Design
Guerilla Human Computer Interaction and Customer Based Design
Quentin Christensen
Fundamental principles of Usability and User Centred Design
Fundamental principles of Usability and User Centred Design
BART RADKA
Lean + UX + Agile: Putting It All Together
Lean + UX + Agile: Putting It All Together
Orthogonal
Recommended
Targeted documentation
Targeted documentation
Alyssa Fox
Integrating User Experience Design into the Product Lifecycle
Integrating User Experience Design into the Product Lifecycle
ICS
It's all about the (customer) experience
It's all about the (customer) experience
ICS
Usability & Agile Development
Usability & Agile Development
binuvt
062311 Sunset Peer To Peer Tele Collaboration Introduction
062311 Sunset Peer To Peer Tele Collaboration Introduction
jesunset8766
Guerilla Human Computer Interaction and Customer Based Design
Guerilla Human Computer Interaction and Customer Based Design
Quentin Christensen
Fundamental principles of Usability and User Centred Design
Fundamental principles of Usability and User Centred Design
BART RADKA
Lean + UX + Agile: Putting It All Together
Lean + UX + Agile: Putting It All Together
Orthogonal
Siblings or Step Siblings? Common Connections Between Technical Communication...
Siblings or Step Siblings? Common Connections Between Technical Communication...
Chris LaRoche
Lean User Experience in a Lean Startup
Lean User Experience in a Lean Startup
Orthogonal
Intro to ux and how to design a thoughtful ui
Intro to ux and how to design a thoughtful ui
Thanos Makaronas
Case Study: Toward Building a New Intranet
Case Study: Toward Building a New Intranet
Andrew Ho
Tablet and Slate Development with Silverlight
Tablet and Slate Development with Silverlight
Jeremy Likness
The importance of identity and vision to UX designers on agile projects
The importance of identity and vision to UX designers on agile projects
johanna kollmann
Final
Final
maulikshah09
Ux introduction training
Ux introduction training
Tim Huff
Introduction To Usability
Introduction To Usability
OMcareers Community
Technical Communicatoin - trends
Technical Communicatoin - trends
Denise Kadilak
User Experience Programme showcase lightening talks
User Experience Programme showcase lightening talks
Neil Allison
Implementing Modernization by Trevor Perry
Implementing Modernization by Trevor Perry
Fresche Solutions
[Seminar] hwiyeon 200709
[Seminar] hwiyeon 200709
ivaderivader
Accelerate Time to Market by Pipelining UX with Development - Part 1
Accelerate Time to Market by Pipelining UX with Development - Part 1
ICS
L07 slides
L07 slides
Ann Bentley
Owning the product by owning the user experience
Owning the product by owning the user experience
Mark Notess
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
UserZoom
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
City Vision University
Agile presentation ONA12
Agile presentation ONA12
vpowers
Web Usability
Web Usability
blacktelephone
пищевые добавки
пищевые добавки
AkuJIa
Development of Communicative Competence Analysis
Development of Communicative Competence Analysis
Joan Cahuich Perez
More Related Content
What's hot
Siblings or Step Siblings? Common Connections Between Technical Communication...
Siblings or Step Siblings? Common Connections Between Technical Communication...
Chris LaRoche
Lean User Experience in a Lean Startup
Lean User Experience in a Lean Startup
Orthogonal
Intro to ux and how to design a thoughtful ui
Intro to ux and how to design a thoughtful ui
Thanos Makaronas
Case Study: Toward Building a New Intranet
Case Study: Toward Building a New Intranet
Andrew Ho
Tablet and Slate Development with Silverlight
Tablet and Slate Development with Silverlight
Jeremy Likness
The importance of identity and vision to UX designers on agile projects
The importance of identity and vision to UX designers on agile projects
johanna kollmann
Final
Final
maulikshah09
Ux introduction training
Ux introduction training
Tim Huff
Introduction To Usability
Introduction To Usability
OMcareers Community
Technical Communicatoin - trends
Technical Communicatoin - trends
Denise Kadilak
User Experience Programme showcase lightening talks
User Experience Programme showcase lightening talks
Neil Allison
Implementing Modernization by Trevor Perry
Implementing Modernization by Trevor Perry
Fresche Solutions
[Seminar] hwiyeon 200709
[Seminar] hwiyeon 200709
ivaderivader
Accelerate Time to Market by Pipelining UX with Development - Part 1
Accelerate Time to Market by Pipelining UX with Development - Part 1
ICS
L07 slides
L07 slides
Ann Bentley
Owning the product by owning the user experience
Owning the product by owning the user experience
Mark Notess
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
UserZoom
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
City Vision University
Agile presentation ONA12
Agile presentation ONA12
vpowers
Web Usability
Web Usability
blacktelephone
What's hot
(20)
Siblings or Step Siblings? Common Connections Between Technical Communication...
Siblings or Step Siblings? Common Connections Between Technical Communication...
Lean User Experience in a Lean Startup
Lean User Experience in a Lean Startup
Intro to ux and how to design a thoughtful ui
Intro to ux and how to design a thoughtful ui
Case Study: Toward Building a New Intranet
Case Study: Toward Building a New Intranet
Tablet and Slate Development with Silverlight
Tablet and Slate Development with Silverlight
The importance of identity and vision to UX designers on agile projects
The importance of identity and vision to UX designers on agile projects
Final
Final
Ux introduction training
Ux introduction training
Introduction To Usability
Introduction To Usability
Technical Communicatoin - trends
Technical Communicatoin - trends
User Experience Programme showcase lightening talks
User Experience Programme showcase lightening talks
Implementing Modernization by Trevor Perry
Implementing Modernization by Trevor Perry
[Seminar] hwiyeon 200709
[Seminar] hwiyeon 200709
Accelerate Time to Market by Pipelining UX with Development - Part 1
Accelerate Time to Market by Pipelining UX with Development - Part 1
L07 slides
L07 slides
Owning the product by owning the user experience
Owning the product by owning the user experience
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
Creating Your Dashboard & Universal Measures with Userzoom – The Deep-Dive Ho...
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
Using Mobile for Your Message: A Process and a Strategy for Mobile Web Develo...
Agile presentation ONA12
Agile presentation ONA12
Web Usability
Web Usability
Viewers also liked
пищевые добавки
пищевые добавки
AkuJIa
Development of Communicative Competence Analysis
Development of Communicative Competence Analysis
Joan Cahuich Perez
Контент и конверсионный трафик. Взаимное влияние
Контент и конверсионный трафик. Взаимное влияние
Анастасия Эебердиева
Выпускной
Выпускной
AkuJIa
Chronological Decomposition Heuristic: A Temporal Divide-and-Conquer Strateg...
Chronological Decomposition Heuristic: A Temporal Divide-and-Conquer Strateg...
Alkis Vazacopoulos
[DDBJing29]DDBJ, NIG SuperComputer, 大量配列情報解析(第29回 DDBJing 講習会 in 三島)
[DDBJing29]DDBJ, NIG SuperComputer, 大量配列情報解析(第29回 DDBJing 講習会 in 三島)
DNA Data Bank of Japan center
Are you a professional
Are you a professional
Sankha Pallab Chakrabarti
[DDBJing29]DDBJ Nucleotide Sequence Submission System の紹介(第29回 DDBJing 講習会 in...
[DDBJing29]DDBJ Nucleotide Sequence Submission System の紹介(第29回 DDBJing 講習会 in...
DNA Data Bank of Japan center
Framework for Action: Engaging with the Post Rio+20 and Post-2015 processes
Framework for Action: Engaging with the Post Rio+20 and Post-2015 processes
Matthew Reading-Smith
Lápis Exilis Catalogue Exhibition
Lápis Exilis Catalogue Exhibition
Maria Sobral Mendonça
Excel+ppt+word2003使用技巧方法大全
Excel+ppt+word2003使用技巧方法大全
0hanfeng0
The Future We Want
The Future We Want
Matthew Reading-Smith
Evalucion
Evalucion
Roberto Sànchez
Indian management
Indian management
panjiarvk2000
Ph detailed dry district maps
Ph detailed dry district maps
Park Hill Neighborhood Association
Ares
Ares
chibook
Crequenewsletterpowerpoint
Crequenewsletterpowerpoint
francesandrobert
PEDAGOGIA INNOVADORA
PEDAGOGIA INNOVADORA
Francisco Robayo
David joan dylan
David joan dylan
eso1113enricborras
Chakala belan
Chakala belan
Jalaja Kumari
Viewers also liked
(20)
пищевые добавки
пищевые добавки
Development of Communicative Competence Analysis
Development of Communicative Competence Analysis
Контент и конверсионный трафик. Взаимное влияние
Контент и конверсионный трафик. Взаимное влияние
Выпускной
Выпускной
Chronological Decomposition Heuristic: A Temporal Divide-and-Conquer Strateg...
Chronological Decomposition Heuristic: A Temporal Divide-and-Conquer Strateg...
[DDBJing29]DDBJ, NIG SuperComputer, 大量配列情報解析(第29回 DDBJing 講習会 in 三島)
[DDBJing29]DDBJ, NIG SuperComputer, 大量配列情報解析(第29回 DDBJing 講習会 in 三島)
Are you a professional
Are you a professional
[DDBJing29]DDBJ Nucleotide Sequence Submission System の紹介(第29回 DDBJing 講習会 in...
[DDBJing29]DDBJ Nucleotide Sequence Submission System の紹介(第29回 DDBJing 講習会 in...
Framework for Action: Engaging with the Post Rio+20 and Post-2015 processes
Framework for Action: Engaging with the Post Rio+20 and Post-2015 processes
Lápis Exilis Catalogue Exhibition
Lápis Exilis Catalogue Exhibition
Excel+ppt+word2003使用技巧方法大全
Excel+ppt+word2003使用技巧方法大全
The Future We Want
The Future We Want
Evalucion
Evalucion
Indian management
Indian management
Ph detailed dry district maps
Ph detailed dry district maps
Ares
Ares
Crequenewsletterpowerpoint
Crequenewsletterpowerpoint
PEDAGOGIA INNOVADORA
PEDAGOGIA INNOVADORA
David joan dylan
David joan dylan
Chakala belan
Chakala belan
Similar to Targeted documentation STC Houston, Mar 20, 2012
User Experience Design for Software Engineers, ICS & The Qt Company
User Experience Design for Software Engineers, ICS & The Qt Company
Qt
Introduction to User Experience Design for Engineers
Introduction to User Experience Design for Engineers
ICS
Introductiontousability 090407053727-phpapp02
Introductiontousability 090407053727-phpapp02
Techved Consulting
Repairing with DITA - Don Day
Repairing with DITA - Don Day
Information Development World
Multi Platform User Exerience
Multi Platform User Exerience
Tanya Zavialova
User Experience Design: an Overview
User Experience Design: an Overview
Julie Grundy
Web engineering
Web engineering
Badrul Alam bulon
Now that you've sold it how do you build it - XMPie Users Conference XUG 202...
Now that you've sold it how do you build it - XMPie Users Conference XUG 202...
Jeffrey Stewart
UX Camp: Pittsburgh, 2017
UX Camp: Pittsburgh, 2017
Tim Broadwater
unit5_usability.pptx
unit5_usability.pptx
SrilekhaK12
Understanding The Value Of User Research, Usability Testing, and Information ...
Understanding The Value Of User Research, Usability Testing, and Information ...
Kyle Soucy
Applying Usability to Improve Value and Reduce Risk
Applying Usability to Improve Value and Reduce Risk
Bonitasoft
Ux Meets Code Interaction Usability
Ux Meets Code Interaction Usability
Arabella David
Introduction To Agile Refresh Savannah July20 2010 V1 4
Introduction To Agile Refresh Savannah July20 2010 V1 4
Marvin Heery
HCI
HCI
Meet Shah
Intoduction to software engineering part 1
Intoduction to software engineering part 1
Rupesh Vaishnav
Web design content
Web design content
MrCHenderson
Web design content
Web design content
MrCHenderson
UXPA Lean UX Bridging the gap between UX and Developers
UXPA Lean UX Bridging the gap between UX and Developers
Andrew Mottaz
Ux guide
Ux guide
Andrew W. Chang
Similar to Targeted documentation STC Houston, Mar 20, 2012
(20)
User Experience Design for Software Engineers, ICS & The Qt Company
User Experience Design for Software Engineers, ICS & The Qt Company
Introduction to User Experience Design for Engineers
Introduction to User Experience Design for Engineers
Introductiontousability 090407053727-phpapp02
Introductiontousability 090407053727-phpapp02
Repairing with DITA - Don Day
Repairing with DITA - Don Day
Multi Platform User Exerience
Multi Platform User Exerience
User Experience Design: an Overview
User Experience Design: an Overview
Web engineering
Web engineering
Now that you've sold it how do you build it - XMPie Users Conference XUG 202...
Now that you've sold it how do you build it - XMPie Users Conference XUG 202...
UX Camp: Pittsburgh, 2017
UX Camp: Pittsburgh, 2017
unit5_usability.pptx
unit5_usability.pptx
Understanding The Value Of User Research, Usability Testing, and Information ...
Understanding The Value Of User Research, Usability Testing, and Information ...
Applying Usability to Improve Value and Reduce Risk
Applying Usability to Improve Value and Reduce Risk
Ux Meets Code Interaction Usability
Ux Meets Code Interaction Usability
Introduction To Agile Refresh Savannah July20 2010 V1 4
Introduction To Agile Refresh Savannah July20 2010 V1 4
HCI
HCI
Intoduction to software engineering part 1
Intoduction to software engineering part 1
Web design content
Web design content
Web design content
Web design content
UXPA Lean UX Bridging the gap between UX and Developers
UXPA Lean UX Bridging the gap between UX and Developers
Ux guide
Ux guide
Recently uploaded
Understanding the Laravel MVC Architecture
Understanding the Laravel MVC Architecture
Pixlogix Infotech
Enhancing Worker Digital Experience: A Hands-on Workshop for Partners
Enhancing Worker Digital Experience: A Hands-on Workshop for Partners
ThousandEyes
Pigging Solutions Piggable Sweeping Elbows
Pigging Solutions Piggable Sweeping Elbows
Pigging Solutions
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men
Delhi Call girls
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
Delhi Call girls
Beyond Boundaries: Leveraging No-Code Solutions for Industry Innovation
Beyond Boundaries: Leveraging No-Code Solutions for Industry Innovation
Safe Software
SIEMENS: RAPUNZEL – A Tale About Knowledge Graph
SIEMENS: RAPUNZEL – A Tale About Knowledge Graph
Neo4j
WhatsApp 9892124323 ✓Call Girls In Kalyan ( Mumbai ) secure service
WhatsApp 9892124323 ✓Call Girls In Kalyan ( Mumbai ) secure service
Pooja Nehwal
Azure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & Application
AndikSusilo4
How to convert PDF to text with Nanonets
How to convert PDF to text with Nanonets
naman860154
Benefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other Frameworks
Softradix Technologies
Human Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR Systems
Mark Billinghurst
Kotlin Multiplatform & Compose Multiplatform - Starter kit for pragmatics
Kotlin Multiplatform & Compose Multiplatform - Starter kit for pragmatics
carlostorres15106
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day Presentation
Michael W. Hawkins
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
BookNet Canada
Artificial intelligence in the post-deep learning era
Artificial intelligence in the post-deep learning era
Deakin University
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Patryk Bandurski
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
Hyundai Motor Group
The transition to renewables in India.pdf
The transition to renewables in India.pdf
Competition Advisory Services (India) LLP
How to Remove Document Management Hurdles with X-Docs?
How to Remove Document Management Hurdles with X-Docs?
XfilesPro
Recently uploaded
(20)
Understanding the Laravel MVC Architecture
Understanding the Laravel MVC Architecture
Enhancing Worker Digital Experience: A Hands-on Workshop for Partners
Enhancing Worker Digital Experience: A Hands-on Workshop for Partners
Pigging Solutions Piggable Sweeping Elbows
Pigging Solutions Piggable Sweeping Elbows
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Friends Colony Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
08448380779 Call Girls In Greater Kailash - I Women Seeking Men
Beyond Boundaries: Leveraging No-Code Solutions for Industry Innovation
Beyond Boundaries: Leveraging No-Code Solutions for Industry Innovation
SIEMENS: RAPUNZEL – A Tale About Knowledge Graph
SIEMENS: RAPUNZEL – A Tale About Knowledge Graph
WhatsApp 9892124323 ✓Call Girls In Kalyan ( Mumbai ) secure service
WhatsApp 9892124323 ✓Call Girls In Kalyan ( Mumbai ) secure service
Azure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & Application
How to convert PDF to text with Nanonets
How to convert PDF to text with Nanonets
Benefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other Frameworks
Human Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR Systems
Kotlin Multiplatform & Compose Multiplatform - Starter kit for pragmatics
Kotlin Multiplatform & Compose Multiplatform - Starter kit for pragmatics
GenCyber Cyber Security Day Presentation
GenCyber Cyber Security Day Presentation
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Artificial intelligence in the post-deep learning era
Artificial intelligence in the post-deep learning era
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Integration and Automation in Practice: CI/CD in Mule Integration and Automat...
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
The transition to renewables in India.pdf
The transition to renewables in India.pdf
How to Remove Document Management Hurdles with X-Docs?
How to Remove Document Management Hurdles with X-Docs?
Targeted documentation STC Houston, Mar 20, 2012
1.
Targeted Documentation STC Houston
Program Meeting Alyssa Fox Senior Manager, Information Development NetIQ Corporation 20 March 2012
2.
Minimalist Documentation Tenets
• Understand the audience. • Create realistic content. • Build basic, minimal, useful documentation. • Provide the right information in the right format at the right time so users can make the right decisions. • Write less, write better. ~ Bernard Aschwanden, Publishing Smarter 2 © 2012 NetIQ Corporation. All rights reserved.
3.
Targeted Documentation Goals
• Provide positive user experience with products. • Provide sufficient information for customers to use our products effectively to achieve their goals. • Provide high-quality documentation based on understanding our users and their content and format needs. • Improve product GUIs so they: – Are as simple to use as possible – Are easy to figure out (self-discoverable) – Require less documentation • Effectively use ―new normal‖ resource numbers. 3 © 2012 NetIQ Corporation. All rights reserved.
4.
Anticipated Benefits
• Clearer content • Easier reuse • More effective use of resources • Reduced costs for maintenance and translation • Improved quality • Fewer Tech Support calls • Better user experience • Happier audience 4 © 2012 NetIQ Corporation. All rights reserved.
5.
Traditional Documentation
• Values comprehensiveness • Values consistency • Steps users through everything in the GUI • Sometimes tries to compensate for bad GUI design • As a result, aims at the least-skilled users 5 © 2012 NetIQ Corporation. All rights reserved.
6.
Targeted Documentation
• Requires solid knowledge of users, their needs, and use cases • Follows CPR writing style • Provides specific information when and where necessary • Provides big picture tasks and workflow • Documents tasks with gotchas you need to know to be successful • Documents best practices • Provides extensive and relevant examples • Provides troubleshooting information • Does not document the obvious or the easily discoverable 6 © 2012 NetIQ Corporation. All rights reserved.
7.
Users as Decision
Makers ―One of my aha! moments came during a usability test of the online help I had written for a predictive dialer—a device that dials phone numbers automatically then, if someone answers, connects that person with the first available call-center agent. On one of the screens, administrators were to set the Busy Callback Time, which I had defined as ―the time the dialer waits before redialing a line that is busy.‖ I had specified the minimum and maximum allowed values—0 and 999 minutes, respectively—and even mentioned that users could click an up arrow to increase the value; a down arrow to decrease the value. And, of course, I also told users to click Save to save their changes. When I tested the online help in a usability lab, I was delighted to see that users actually opened the help topic I had written for that screen. But when the users started reading my help, I learned the following: • The label Busy Callback Time was self explanatory — everybody got it right away. • No one wanted to set the value to less than zero. (Apparently time travel buffs don’t work in call centers.) • No one tried to set a value that was even close to going over the allowed maximum and, if someone had, the system would not have accepted the value. • Everyone figured out the up and down arrows without my help. • They figured out the Save button on their own, too. In the end, users went to the online help with one simple question: “What’s a good number of minutes to delay before calling back?” It seems that was the only thing I had not documented.” ~ Michael Hughes, Intercom, February 2009 7 © 2012 NetIQ Corporation. All rights reserved.
8.
Writing Style &
Documentation Format • Style guide • Writing for translation and ESL • Templates • Topic-based writing • Books converted to Help (single-sourcing) • Books available in PDF and HTML • Context-sensitive Help in addition to converted topics • Web-hosted documentation • User assistance in GUI 8 © 2012 NetIQ Corporation. All rights reserved.
9.
Content Design
• Installation – comprehensive • Configuration – comprehensive • Usage (tasks/procedures) – targeted – Perform task analysis. – Determine how obvious the GUI is around that task. – Fix the GUI first! • Concepts/best practices – targeted • Reference – targeted • Troubleshooting – comprehensive 9 © 2012 NetIQ Corporation. All rights reserved.
10.
Targeted Documentation
Best Practices • Start with the minimum information a user needs. • Provide what the user needs to know, not what you know. • Describe why you would use a feature or perform a task with the software, and relate that information back to users’ goals. • Add graphics, screenshots, and demos where relevant and useful. • Assume the user has knowledge appropriate for their jobs. • Let the UI speak for itself, and don’t repeat the obvious. • Title topics in a meaningful way – Developing a Database Maintenance Strategy vs. Using the XYZ Tab. • Get out of book-mode. – ―My brain is stuck in book-mode. I figure it’s going to take my brain a while to stop thinking linearly. I must consciously think of what information a user needs to solve the problem at hand and no more.‖ ~ Patty Blount 10 © 2012 NetIQ Corporation. All rights reserved.
11.
User Experience
• Usability testing • Assistance with GUI wording and screen flow for developers • Guidelines for error messages • Usability bugs • Pushback on fixing GUI problems with documentation How can we improve the GUI so that less doc is required? How can we design new GUIs or Help systems so every window doesn’t require a Help topic? 11 © 2012 NetIQ Corporation. All rights reserved.
12.
Evangelizing Targeted Documentation
• Understand that this approach is a change. • Be prepared for varied reactions from your project team. • Ensure you can support your decisions to those who don’t understand what you’re doing. • Gain buy-in from your user advocates and project teams. • Keep in mind the big picture goals. • Recognize that this change will not happen overnight. • Communicate, communicate, communicate! 12 © 2012 NetIQ Corporation. All rights reserved.
13.
Defining Your Users
• Continually clarify user descriptions, personas, and use cases. – User definition meetings with user advocates (product managers, Tech Support, field) – Customer forums – Tech Support sessions – Sprint demos – User conferences – User comments on online documentation • Developers, testers, writers: You are not your user. 13 © 2012 NetIQ Corporation. All rights reserved.
14.
Defining Top Tasks
• What problems does this product or solution solve for our users? • What are the core tasks the user wants to accomplish? – What are the essential tasks? (modified task analysis) – What are important but non-essential tasks? (not top priority) – What top user goals can we base our core tasks on (not based on product features)? – What tasks are discoverable by the user? (don’t document) 14 © 2012 NetIQ Corporation. All rights reserved.
15.
Conducting a Task
Analysis • ―A thorough task analysis is the route to minimalist publications…‖ JoAnn Hackos, Managing Your Documentation Projects • Document tasks from the user perspective, not the GUI perspective. – What did the customer buy our software to provide? – What are the most common use cases? – What are our users’ goals? – How does our software get our users to their goals? • Provide big picture overviews: ―Lifecycle of an Alert‖. • Create workflow tasks from the user perspective. • Do not mimic the product’s structure (such as documenting menus from left to right). 15 © 2012 NetIQ Corporation. All rights reserved.
16.
Building the Plan
• Ensure you address main areas cited by users: – Planning – Installation and configuration – Top tasks – Troubleshooting • Work usability testing into your plan. • Determine what existing source material fits into your new plan, what needs to be rewritten, and what outdated or obvious information you can remove. • Don’t build the plan based on current books or help structure. 16 © 2012 NetIQ Corporation. All rights reserved.
17.
Reviewing and Refining
the Plan • Review your plan with your manager to gather feedback on documentation organization and content. • Review your plan with project stakeholders to ensure the plan addresses top user needs. • Incorporate feedback into the plan. • Create a schedule for incrementally building targeted documentation into existing documentation libraries over multiple releases. 17 © 2012 NetIQ Corporation. All rights reserved.
18.
Reviewing and Refining
the Plan Questions? Thank you. 18 © 2012 NetIQ Corporation. All rights reserved.
Download now