anamika mukherjee december 2014...the tech writing approach . new features in this release: drag and...
TRANSCRIPT
Anamika Mukherjee
December 2014
What is Tech Writing? Documents Documents More documents…
… and maybe online help
2 STC India 2014
What’s Wrong with Documents? Nobody reads
documents Too much information Not user-friendly Narrative format Information is outside
the application Not suitable for small
form factor devices
3 STC India 2014
What is User Assistance? What kind of assistance do users need?
Conceptual information Reference information Help on completing tasks
When do users need assistance? First time they use a product or feature Whenever they want to change something When they run into trouble
4 STC India 2014
Types of User Assistance Wizards and assistants Buttons and labels Screen titles Rollover text and tool tips In-field text Warning and error messages Man pages Help center Training Videos … and documents
5 STC India 2014
The Tech Writing Approach The New User Registration screen appears. Enter the
following details: Name: Enter your first name and your last name. Choose Your Username: blah blah blah . . . Birthday: Enter your date of birth in the following format: Month: The name of the month in words. For example:
Januray, February, March… Day: The date in numerals. For example: 1, 2, 3… Year: The year in numerals. For example: 1990, 1991, 1992…
STC India 2014 6
In-field text
Format for user entry
7 STC India 2014
How UA Does It
The Tech Writing Approach Note: You must supply your first name and last name.
These are mandatory fields. You can’t leave these fields empty.
Note: Your username can include letters, numbers, and
periods, but no special characters. Tip: Don’t use a password that you’ve used elsewhere.
Don’t use a password that’s very obvious, like your pet’s name.
STC India 2014 8
9 STC India 2014
How UA Does It
https://accounts.google.com/SignUp
The Tech Writing Approach New Features in this Release: Drag and drop
This new feature allows you to rearrange your application icons by dragging each icon from its current location and placing it over the desired location. The other icons are rearranged automatically.
You can customize your interface by adding items to the menu or toolbar. Just use drag and drop to add or remove icons from the menu or toolbar.
STC India 2014 10
STC India 2014 11
The Tech Writing Approach Contents
Introduction to <Product Name>……………………………..5 . . .
Features of <Product Name>………………………………… 23 . . .
Using <Product Name> ………………………………………….180 . . .
Appendix A……………………………………………………………..1356
STC India 2014 12
STC India 2014 14
http://www.lynda.com/HTML-tutorials/HTML-Essential-Training-2012/99326-2.html
STC India 2014 15
https://developer.paypal.com/docs/api/#create-a-payment
STC India 2014 17
http://www.online.citibank.co.in/products-services/online-services/cbol-flash/demo.html
Benefits of User Assistance Just enough information Specific, task-focused information Embedded - doesn’t direct users away from the
product Easy to find, hard to miss Adapted to a variety of devices
18 STC India 2014
Tools Acrobat Captivate Flare Framemaker Illustrator Photoshop RoboHelp SnagIt Visio Camtasia*New
19 STC India 2014
http://www.welinske.com/2014-user-assistance-tools-survey/
Skills Think like a user Use your product Communicate
Write Speak Show
Anything else?
20 STC India 2014
Challenges New skills New tools New processes and work flows for integrating and
updating content New stakeholders and internal customers
STC India 2014 21
Questions?
22 STC India 2014