Enhancing Existing Documentation with Technical Communication Suite

  • Published on
    09-Jun-2015

  • View
    137

  • Download
    1

Embed Size (px)

Transcript

  • 1. Enhancing Existing Documentation with Technical Communication SuiteT M Aldous | Adobe Product Evangelist |Twitter @tmaldous | tmaldous.com | taldous@adobe.comColum McAndrew | Senior Technical Writer IDBS | cmcandrew@idbs.com 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.

2. The E-WorkBook SuiteE-WorkBookChemBook BioBook 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 2 3. The rough and the smoothThe good news was ...There was no shortage of content.Most of it was pretty accurate!We had a mandate for change.The bad news was ...We had a disparate group of documents.Some content lacked detail.Little thought had been given to navigation. 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.3 4. The E-WorkBook Suite documentationE-WorkBookTraining Reference Guides x 3Help Files x 4BioBook HTML Help (CHM)ChemBook Assorted User Guides x 20 White Papers x 10 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 4 5. Project objectives PrimarySecondary Redesign the structure ofHost the documentationthe documentation.online (RoboHelp Server). Rewrite the content with Provide CHM files asdue reverence to contextbackup.and navigation. Provide users with movie Provide sufficient detail totutorials for additionalthe desired audience. context. Implement a consistent Reuse content as much asstyle.possible. 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 5 6. Adobe / IDBS Contact Information Contact Information Tom AldousBlog -http://tmaldous.com Adobe Systems, Inc. Twitter - http://twitter.com/@tmaldous Adobe Product EvangelistEmail - email://taldous@adobe.com Web - http://www.adobe.com Colum McAndrewBlog -http://www.cmcandrew.com/robocolumn IDBSTwitter - http://twitter.com/@robocolumn Senior Technical Writer Email - email://cmcandrew@idbs.com Web - http://www.idbs.com 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 6

Recommended

View more >