home

Writing for Hard Copy and Online - Help Authoring Site

home Buy This Domain search
Help Authoring: Writing for Hard Copy and Online - Help Authoring Site

Writing for Hard Copy and Online - Help Authoring Site

Use separate templates for hard copy and for online documents.

Three sets of documents

Consider creating three different sets of documents:

  • Print only
  • Help only
  • Both Help & Print (80% of the material)

Use the following technique

  1. Use EasyHelp/Web as a global add-in and use 2 different document templates, one for print (say PRINT.DOT) and one for online(say ONLINE.DOT)
  2. Make sure you use Word paragraph and character styles.
  3. Make sure each template has the same style names and have the Word "automatically update document styles" option set to on.
  4. Refer to Chapter 19: Help -- Managing Large Publications

Points to bear in mind

  • The Word Auto generated Table of Contents cannot be used (and does not look good) for your help TOC. This where the concept of a 'Print only' part of documentation comes in.
  • Also the contents page for the help would be the 'Help only', because it often need to be laid our specifically for online with icons etc.
  • A printed TOC would have page numbers whereas a 'Help' contents does not. Hence you might need a 'Print' version and a 'Help' version.
Help Authoring: Writing for Hard Copy and Online - Help Authoring Site

Amazon Prime Free Trial


Help Authoring: Writing for Hard Copy and Online - Help Authoring Site