Enhancing Existing Documentation with Technical Communication Suite
?Download as PPTX, PDF?
1 like?294 views
This document discusses enhancing existing technical documentation for the E-WorkBook Suite. It describes the initial documentation as disparate and lacking in navigation. The project objectives were to redesign the documentation structure, rewrite the content with improved context and navigation, provide sufficient detail for the intended audience, and implement consistent styling. The documentation would also be hosted online and CHM files provided as a backup, with movies added for additional context. Contact information is provided for representatives from Adobe and IDBS.
Enhancing Existing Documentation with Technical Communication Suite
- 1. Enhancing Existing Documentation with Technical Communication Suite T M Aldous | Adobe Product Evangelist |Twitter @tmaldous | tmaldous.com | taldous@adobe.com Colum McAndrew | Senior Technical Writer IDBS | cmcandrew@idbs.com ? 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
- 2. The E-WorkBook Suite E-WorkBook ChemBook BioBook ? 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 2
- 3. The rough and the smooth The 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 documentation E-WorkBook Training Reference Guides x 3 Help Files x 4 BioBook 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 Primary Secondary ? Redesign the structure of ?Host the documentation the documentation. online (RoboHelp Server). ? Rewrite the content with ?Provide CHM files as due reverence to context backup. and navigation. ?Provide users with movie ? Provide sufficient detail to tutorials for additional the desired audience. context. ? Implement a consistent ?Reuse content as much as style. possible. ? 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential. 5
- 6. Adobe / IDBS Contact Information Contact Information Tom Aldous Blog - http://tmaldous.com Adobe Systems, Inc. Twitter - http://twitter.com/@tmaldous Adobe Product Evangelist Email - email://taldous@adobe.com Web - http://www.adobe.com Colum McAndrew Blog - http://www.cmcandrew.com/robocolumn IDBS Twitter - 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