Successfully reported this slideshow.

Online help print_docs_wiki_stc_july2010

671 views

Published on

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Online help print_docs_wiki_stc_july2010

  1. 1. Online Help & Print Documentation: Using Wiki By Gurpreet Singh & Suman Lata Malik Saturday, July 24, 2010 STC Regional Conference, New Delhi
  2. 2. Contents <ul><li>Traditional Approach </li></ul><ul><li>Barriers in Traditional Approach </li></ul><ul><li>Search for Future proof and Collaborative approach </li></ul><ul><li>We found it the Wiki Way! </li></ul>
  3. 3. What we do? <ul><li>Develop end user documentation for a fleet of 8 commercial EDA tools, updated several times in a year </li></ul><ul><li>Maintain/Develop over 1,25,000 pages of technical content, in several languages </li></ul><ul><li>Generate output in html help, chm, pdf and web accessible format </li></ul>
  4. 4. Traditional Approach <ul><li>Growth from one major annual release for three products to quarterly release for eight products </li></ul><ul><li>No increase in headcount </li></ul><ul><li>Unrealistic workload of over 200 books (over 30,000 pages), updated several times a year </li></ul>
  5. 5. Traditional Approach Write Format Edit Review Index Link Generate Build Install
  6. 6. Traditional Approach 65% of Time (was) Spent Formatting and Building Content
  7. 7. Search for Alternatives <ul><li>15 million articles </li></ul><ul><li>Over 3.3 million English articles </li></ul><ul><li>Articles in 261 languages </li></ul>
  8. 8. Search for Alternatives
  9. 9. Search for Alternatives
  10. 10. Search for Alternatives TWiki Confluence Mediawiki
  11. 11. Confluence Wiki <ul><li>Paid wiki (A 500-user Confluence license costs half the price of a single-user FrameMaker-WebWorks Publisher license) </li></ul><ul><li>Almost zero down-time </li></ul><ul><li>Amazingly easy to use for all tasks, from Administration to Authoring </li></ul>
  12. 12. Moving the Mountain <ul><li>TRANSLATE: Modified WebWorks Publisher template to generate Wiki Markup output from FrameMaker files </li></ul><ul><li>CLEAN UP: Perl scripts to further clean the output-remove double-spaces, add file names, titles, etc </li></ul><ul><li>TRANSFER: Addition of wiki-markup in respective wiki spaces </li></ul>
  13. 13. References <ul><li>“ Printed Books and Online Help Using a Wiki”- STC Annual Conference 2008, Philadelphia- Rahul Mehrotra </li></ul><ul><ul><li>http://sites.google.com/site/moremiscellany/works/wiki-publishing/Printed-Books-and-Online-Help-Using-a-Wiki </li></ul></ul><ul><li>DMOZ </li></ul><ul><ul><li>http://www.dmoz.org/Computers/Software/Groupware/Wiki/Wiki_Engines/ </li></ul></ul><ul><li>Wiki Matrix </li></ul><ul><ul><li>http://www.wikimatrix.org </li></ul></ul>
  14. 14. Thanks for attending! G urpreet Singh is a professional writer and a trainer based in New Delhi having a keen interest in Human Psychology. He works in the creative realms of Technical Writing, Business Writing (MarCom), Web-Copy Writing and Training. He can be contacted at [email_address] . More tips and information available at: http://gurpreetwrites.wordpress.com S uman Lata Malik is an experienced technical and marketing communication professional with a passion for developing and executing communication strategies for complex technical and marketing documentation efforts. She is the founder and chief consultant of Infotechwriter Documentation Services, a startup company based in New Delhi. She can be contacted at: [email_address] www.infotechwriter.asia

×