Online Help
Technical Writing
RoboHelp Courses

Web Design
Graphics & Layout

Marketing Writing
Our Clientele
Company Profile
Free Software

General Inquiries
Paula R. Stern

Our Team

Help conversions typically involve taking a document that was written for print and converting it to an online format. The process has been significantly streamlined in the last few versions of RoboHelp, but here are some general tips. In many cases, if you avoid some writing styles and techniques when writing the print manual, you can save significant time during the conversion. In other cases, by creating a "help" template that can be attached to the document in place of the print template, you may save time by quickly "righting" some problematic styles. 

The following sections are divided into:

• Tips for writing right

• Conversion suggestions
  

Tips for Writing Right

1. Avoid using heading numbering (or create a separate help template without numbering and attach the help template when beginning the conversion).

2. Avoid referring to graphics within the body of the text.

3. Avoid using captions (or apply a separate style that can easily be deleted).

4. Use two styles for graphics: one that indicates screen captures and other graphics that will be deleted and another that is used for graphics that will remain in the help file (for example: flow charts, system architecture, explanatory graphics, etc.).

5. Avoid using "book" words:
   pages (acceptable when documenting HTML or web-based application)
   chapters
   index
   appendix
   manual

6. Avoid using words which indicate locations:
   above
   below
   following

7. When creating cross-references, use hyperlinks. These convert to links in RoboHelp.

8. Consider designing two different templates:
     Standard document template (could use heading numbering, etc.)
     Help template (use this to automatically delete heading numbers, change font, etc.)  before conversion.

9. If going from help to print, design the Word template before the conversion to print.

10. Consider using existing skins, templates, .css files, etc. to help make give your documentation a consistent look and feel.

Conversion Suggestions

1. If you have separated chapters into many files, consider combining the files into one. This makes the table of contents easier to create automatically and easier to import at one time. You can easily import parts of chapters or individual chapters and still automatically build the TOC (so balance ease of one import with the difficulty of working with a large file and decide what is easiest for you).

2. Delete unwanted graphics before conversion.

3. Remove captions before conversion.

4. Remove figure/table headings.

5. Delete section numbering.

6. Check cross-references for rephrasing.

7. Make sure you've written your help in an online-friendly way. Avoid words that don't belong (chapter, books, etc.

8. Search for words that may not make sense after the conversion (in the following screen capture; in table 4.5; in the following section, etc.)