When creating content within my Help System, I often put my content through a review process. Reviews help to ensure my content is correct and easy to understand.
A recurring question by RoboHelp users is how they can use RoboHelp to gather reviews efficiently. Fortunately, RoboHelp has a review option that allows reviewers who don't own Adobe RoboHelp to review your RoboHelp content. The only thing reviewers need is a PDF of your RoboHelp content, Adobe Acrobat or the free Adobe Reader.
Working with shared reviews consists of three stages:
- Creating a PDF for review
- The review
- Importing the reviewer comments into RoboHelp
In the steps that follow, I will show you how to create a review PDF locally. Saving locally is the easiest way to start a review because you don't have to set up a server or accounts.
- Open or create a RoboHelp project.
- Choose Review > Create PDF for Review.
- In the Create PDF for review dialog box, select any (or all) of the topics, snippets and master pages you want to include in the PDF.
- From the PDF Settings area, select Save locally.
- Select Enable commenting in Adobe Reader.
- Click OK to create the PDF.
(Note: You will only be able to select this option if you have Adobe Acrobat 10 installed on your computer.)
RoboHelp creates the PDF document and opens the document in Acrobat. (If Acrobat notifies you that it will enable commenting, click OK and save the document.)
The PDF is now ready for review. You can now send the PDF to all of your reviewers.
Important: After you create the PDF, don't edit the RoboHelp topics, snippets and master pages that are included in the PDF. The only way you can reliably import comments back into the RoboHelp project is when the content remains unchanged.
Reviewers can review your content using Adobe Acrobat or the free Adobe Reader. Using the Annotation tools, reviewers can add comments, remove text, insert text and replace text. When the review is finished, the reviewer simply sends the annotated PDF back to you.
Once you receive the review PDF, you can import the comments and changes suggested within the PDF directly into the RoboHelp project.
- Open the reviewed RoboHelp project.
- Choose Review > Import Comments from PDF.
- Click Yes from within the Import comments from PDF dialog box and then open the reviewer's PDF.
Once the import is complete, RoboHelp displays the comments, inserts and deletions similar to the Track Changes feature in Microsoft Word.
At this point, you can use a Review toolbar to accept or reject suggested changes within your project.