Progress
Help Development
Guide
Topic Style Guidelines
In planning your help topics, keep them as brief as possible. To keep topics modular, avoid lengthy introductory paragraphs, complex concepts and comparisons, transitional passages, and text-based cross-references. Many of the techniques that make for good printed material do not translate well into online help.
Instead of writing long help topics that must be scrolled into view while the user reads the text, try to limit each help topic to the amount of information that can fit within its window type. Use hypertext features to lead the user to more information on related subjects.
Whether you are working with previously written material or developing your help topics from scratch, it is important to edit your text rigorously and to format it for maximum readability online. Table 2–4 summarizes some basic style guidelines.
The remaining two chapters explain how to create topic, contents, and project files, and how to compile them to create a help project.
The instructions in these chapters assume that you are using only the utilities that are provided with your Progress product, plus MS-Word and accessories that are supplied with Windows. Note that there are many help authoring tools available that can save you time by automating many of the tasks described in this chapter.
For complete reference information on all aspects of Windows help development, see the Help Author’s Guide , an online help file associated with Help Workshop,
\Program Files\Progress\bin\hcw.hlp
. Help Workshop,\Program Files\Progress\bin\hcw.exe,
is a Microsoft utility provided with Progress.
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |