home *** CD-ROM | disk | FTP | other *** search
- (@title Style Considerations@)
- Simply pulling text from a manual and throwing it on the screen is not
- sufficient for creating effective on-line documentation. You have a
- completely different medium to deal with, one that has its drawbacks as
- well as its advantages.
-
-
-
- A complete text on what's good and bad for on-line documentation would fill
- a book (it has actually filled several). If you're interested in learning
- more, a good starting point is the book "Documentation Style: From Paper
- to On-line" by John R. Brockman.
-
-
-
- Fortunately, there are only a few important things to remember for creating
- on-line documentation. Since screen fonts are generally harder to read
- than text on paper, most of these points have to do with minimizing the
- amount of text presented at one time.
-
-
-
- - Try to limit the number of ideas or concepts to one per screen.
-
-
-
- - Keep the help windows away from the edges of the screen as much as
- possible. CRT screens tend to lose focus at the edges; the reader has to
- work harder to read text along the edges. Use the window-positioning
- environment variables to do this (the user might change these, but that's
- his choice -- you do what you can).
-
-
-
- - Use a larger font size, if it's available. Topaz 9 is much easier to
- read than Topaz 8.
-
-