Innovative documentation projects, including documentation for Kindle, tablets, and smartphones, screencasts, blogs, Twitter, user comments and ratings, web analytics, process improvements for aaccessibility, and translation time and cost savings. Based on a webinar by Marta Rauch and Gail Chappell for the Society for Technical Communication in 2011.
Generative Artificial Intelligence: How generative AI works.pdf
Making it Better: Taking Your Innovative Documentation to the Next Level
1. <Insert Picture Here>
Making It Better! Taking Your Innovative Documentation to the
Next Level
@martarauch
Marta Rauch, Gail Chappell
STC Webinar, 2/24/2011 +Marta Rauch
2. Your Presenters Today
Marta Rauch Gail Chappell
Principal Information Developer Senior Principal Technical Writer
Planning ID Team Lead JavaFX Team Lead
EPM Documentation Portal Page JavaFX Technical Documentation
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
2
3. Agenda
Kindle, Tablets, Smart Phones
Screencasts
Translation
Blogs, Twitter
Web Analytics
Fresh Content
Accessibility
User Comments, Ratings
Question and Answer Session
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
3
4. Kindle, Tablets, Smart Phones: The New PC
Good
Market 2010 2011 2012
Online library
Growth
Tablets 17 million 44 million 70 million
Usability testing eReaders 10 million 14 million 16 million
Doc portal
Making it Better
Kindle-compatible format
Versatile
iPad, iPhone, Droid, tablets
Market leader
Free eReaders
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
4
5. Screencasts: A Supplement to Written Docs
Good
Written docs +
screencasts
Making it Better
Know your audience
Know your content
http://download.oracle.com/javafx/1.3/tutorials/image_slideshow/video.html
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
5
6. Translation: Word Reduction is a Good Thing
Good
Training
Style guidelines
Making it Better
Word reduction
One glossary
% Words Savings Savings for All
Reduced per Guide Languages
XML 10% $2,880 $74,880
20% $5,760 $149,760
Content Management System
30% $8,640 $219,960
Automation 40% $11,520 $299,520
50% $14,400 $374,400
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
6
7. Blogs and Twitter: A Quick Dose of Information
Good
Promotions
Tidbits
A day in the life
Making it Better
Credibility
Group accounts
Accountability
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
7
8. Web Analytics: A Way to Measure Your Success
Good
Usability tests
Productivity metrics
Customer feedback
Making it Better
Track usage data
Downloads
Click-maps
Entry and exit pages
Automated reports
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
8
9. Fresh Content: A Hook to Keep Users Interested
Good
Live website with
changing content
Making it Better
Cohesive organization
Showcase design
End-of-life process
http://download.oracle.com/javafx/
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
9
10. Accessibility: Reaching All of Your Customers
Good
Accessibility guidelines
Alternative text
Making it Better
Built in to template
Reports
Usability tests
Screen readers
Keyboard equivalents
Accessibility checker
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
10
11. Comments and Ratings: Conversations With Users
Good
Kudos, questions,
improvements, and bugs
Making it Better
Guidelines
Moderators
Close-out policy
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
11
12. Key Takeaways
• Kindle, Tablets, Smart Phones: The new PC
• Screencasts: A supplement to written docs
• Translation: Word reduction is a good thing
• Blogs, Twitter: A quick dose of information
• Web Analytics: A way to measure your success
• Fresh Content: A hook to keep users interested
• Accessibility: Reaching all your customers
• Comments, Ratings: Conversations with users
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
12
13. Q U E S T I O N S & A N S W E R S
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
13
14. Final Thought
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
14
15. Thank You!
For more information, contact us:
@martarauch
+Marta Rauch
Attend our presentations at these 2011 conferences:
Content Management Strategies/DITA 2011,
April 2-4 in Baltimore, MD
STC Summit 2011
May 15-18 in Sacramento, CA
Lavacon 2011
November 13-16 in Austin, TX
Marta Rauch and Gail Chappell, “Making It Better! Taking Your Innovative Documentation to the Next Level” STC Webinar, 2/24/2011. Copyright 2011.
15