Upload
colum-mcandrew
View
142
Download
1
Embed Size (px)
Citation preview
© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
T M Aldous | Adobe Product Evangelist |Twitter @tmaldous | tmaldous.com | [email protected]
Colum McAndrew | Senior Technical Writer IDBS | [email protected]
Enhancing Existing Documentation with Technical Communication Suite
© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
The E-WorkBook Suite
2
E-WorkBook
ChemBook BioBook
© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
The rough and the smooth
3
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.
The E-WorkBook Suite documentation
4
Training Reference Guides x 3
Assorted User Guides x 20
White Papers x 10
Help Files x 4
HTML Help(CHM)
ChemBook
BioBook
E-WorkBook
© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
Project objectives
5
Primary
Redesign the structure of the documentation.
Rewrite the content with due reverence to context and navigation.
Provide sufficient detail to the desired audience.
Implement a consistent style.
Secondary
Host the documentation online (RoboHelp Server).
Provide CHM files as backup.
Provide users with movie tutorials for additional context.
Reuse content as much as possible.
© 2010 Adobe Systems Incorporated. All Rights Reserved. Adobe Confidential.
Adobe / IDBS Contact Information
6
Contact Information
Tom AldousAdobe Systems, Inc.Adobe Product Evangelist
Blog - http://tmaldous.comTwitter - http://twitter.com/@tmaldousEmail - email://[email protected] - http://www.adobe.com
Colum McAndrewIDBSSenior Technical Writer
Blog - http://www.cmcandrew.com/robocolumnTwitter - http://twitter.com/@robocolumnEmail - email://[email protected] Web - http://www.idbs.com