Re: Review Process for CHM File
***Disclaimer: I do not use VSS or any source control software. ***
From where I'm sitting, it is complicated. There's two issues that are
intertwined like the Rush rhythm section during "YYZ":
1) authors making changes to content that is being reviewed
2) how to get feedback from reviewers when the content to be reviewed is
in a CHM file.
For 1), I think the bottom-line is there has to be a "cut" or "freeze"
of your CHM file. After your "cut," you need to provide all these depts
with the same version of the same content and give them a due date of,
say, 1 week from the day they get it. Part of your instructions to them
needs to include which areas each group should focus upon. Then, during
the review period, do not allow any author to make any changes to the
content that is being reviewed.
For 2), I can tell you what I do. On each of my HTML pages, I use
Javascript to create a customized Feedback section you see when you are
looking a Microsoft page in their KB, with the "Was this information
helpful?" etc. section. When our users fill out that section and click
Submit, an email is sent to me. The way my feedback thing works is I get
the name of the HTML file within the email. *IF* you have something like
that, it would be relatively easy for someone to read the content, then
use that survey to say, "Yes, looks good" or "No, needs work" and to use
the name of the HTML file as a check list within your RoboHelp project
by marking the reviewed files with an updated status <your choices are
"In Progress," "Complete" and "Ready for Review." You'd need to have all
your files set to the same way, say "Ready for Review" and then when the
reviewers start submitting changes, change the status to "Complete."
Then you could run a report to get something like this:
|
In Progress
Topics: 908
Estimated Time: 0 hours
Ready for Review
Topics: 0
Complete
Topics: 3
Total Time: 0 hours
|
So that's one stab at it. You are definitely right, though, that a MS
Word doc and track changes would work very well.
Paul Hanson
Technical Writer
RoboHelp ACE -
http://www.macromedia.com/support/forums/team_macromedia/robohelp.html
Quintrex Data Systems http://www.quintrex.com
email: phanson at quintrex.com
-----Original Message-----
From: Kamran Rasool
<snip>
Now my question is how can I get this help doc reviewed by sales and
marketing, engineers and quality engineers? Where and When do we control
the content of the CHM file? How we get it reviewed and updated while
authors are constantly writing in Realtime using VSS? Complicated right
:(? I know I really need some help here.....
</snip>
--
Kamran Rasool.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
To unsubscribe send a blank email to techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
References:
Review Process for CHM File: From: Kamran Rasool
Previous by Author:
Review Process for CHM File
Next by Author:
Re: Review Process for CHM File
Previous by Thread:
Review Process for CHM File
Next by Thread:
RE: Review Process for CHM File
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads