Don’t Hide Your ContentClick to edit MasterSystemin a Traditional Help title styleA case study for implementing a DITA-bas...
Our Client’s Pain   “We change…when the   PAIN of staying the same   becomes greater than the   pain of changing!”   —Henr...
Our Client’s Pain, cont.1. Time consuming publishing                           =                                          ...
Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting                            =         ...
Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting3. Content duplication                ...
Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting3. Content duplication4. Inconclusive ...
Result of Not Addressing Pain• Delayed time to market• Inaccurate and inconsistent documentation• Low user satisfaction ra...
Solution KeyContent duplication• Topic-based authoring• Reuse features for – Topics                 DITA – Paragraphs – Ph...
Solution #1Reduce the publishing effort• Switched from Frame and MadCap Flare to  XMetal authoring and DocZone CMS storage...
Solution #2Make the brand styling consistent• Applied consistent brand styling specifications                PDF          ...
Solution #3Reduce duplication• Applied a content reuse strategy – Reusable topics, paragraphs,   phrases, table rows – Con...
Solution #4Make content more accessible• Provided an HTML5 help system accessible on the Internet    Framesets/iFrames   ...
Results of Re-Engineering• Automated publishing  Decreased cost to update content by 15%  Reduced time to output content –...
Results of Re-Engineering, cont.• Accessible HTML5 help system  Enabled users to search the Internet – Provided immediate ...
Demo                  15       00.00.08
SummaryWhy not…• Automate publishing• Reuse content• Open help topics to search engines• Make help available on any device...
Questions                        +                 +   925-956-4215   WWW.techprose.com   paula@techprose.com   http://www...
Upcoming SlideShare
Loading in …5
×

Tech prose dont hide your content in traditional help

448 views

Published on

Don't Hide Your Content in a Traditional Help System by Paula Toth, Best Practices Lead at TechProse. When people have questions, they turn to an Internet-capable device and search for answers. One way to give users access to content is to put it on the Internet. But some help systems use architectures, plugins and web services that restrict search access to the valuable content they contain. However, an HTML help system doesn rely on these technologies. That's why TechProse selected HTML 5 and DITA, managed by DocZone, to deliver help content on a recent project. This presentation walks you through our process.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
448
On SlideShare
0
From Embeds
0
Number of Embeds
15
Actions
Shares
0
Downloads
5
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Tech prose dont hide your content in traditional help

  1. 1. Don’t Hide Your ContentClick to edit MasterSystemin a Traditional Help title styleA case study for implementing a DITA-based HTML5 help system
  2. 2. Our Client’s Pain “We change…when the PAIN of staying the same becomes greater than the pain of changing!” —Henry Cloud 2 00.00.08
  3. 3. Our Client’s Pain, cont.1. Time consuming publishing = 3 00.00.08
  4. 4. Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting = 4 00.00.08
  5. 5. Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting3. Content duplication 5 00.00.08
  6. 6. Our Client’s Pain, cont.1. Time consuming publishing2. Inconsistent brand formatting3. Content duplication4. Inconclusive search results 6 00.00.08
  7. 7. Result of Not Addressing Pain• Delayed time to market• Inaccurate and inconsistent documentation• Low user satisfaction ratings• Increasing support burden 7 00.00.08
  8. 8. Solution KeyContent duplication• Topic-based authoring• Reuse features for – Topics DITA – Paragraphs – Phrases – Rows in tables 8 00.00.08
  9. 9. Solution #1Reduce the publishing effort• Switched from Frame and MadCap Flare to XMetal authoring and DocZone CMS storage/publishing• Automated publishing to PDF and online help 9 00.00.08
  10. 10. Solution #2Make the brand styling consistent• Applied consistent brand styling specifications PDF Online Help 10 00.00.08
  11. 11. Solution #3Reduce duplication• Applied a content reuse strategy – Reusable topics, paragraphs, phrases, table rows – Conditions and filtering 11 00.00.08
  12. 12. Solution #4Make content more accessible• Provided an HTML5 help system accessible on the Internet  Framesets/iFrames  Tables used for page formatting  Services running on the server  Plugins/Flash/Flex  CHM  Robohelp  MadCapFlare  Adobe Air  Eclipse Help 12 00.00.08
  13. 13. Results of Re-Engineering• Automated publishing Decreased cost to update content by 15% Reduced time to output content – From 16 to 1.5 hours for PDF – From 4 weeks to 15 minutes for online help• DITA reuse features Enabled authors eliminate content duplication – Reduced the words in the repository by 50% – Decreased the cost to update content by additional 35% – Eliminated inaccuracies and inconsistencies introduced by duplicated content 13 00.00.08
  14. 14. Results of Re-Engineering, cont.• Accessible HTML5 help system Enabled users to search the Internet – Provided immediate answers to questions – Provided access to answers from any device – Increased user satisfaction ratings 14 00.00.08
  15. 15. Demo 15 00.00.08
  16. 16. SummaryWhy not…• Automate publishing• Reuse content• Open help topics to search engines• Make help available on any device + + 16 00.00.08
  17. 17. Questions + + 925-956-4215 WWW.techprose.com paula@techprose.com http://www.linkedin.com/in/paulatoth 17 00.00.08

×