Re: PDFs and Online Documentation

Subject: Re: PDFs and Online Documentation
From: Dan Emory <danemory -at- primenet -dot- com>
To: Damien Braniff <dbraniff -at- iss-dsp -dot- com>, "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 11 May 2000 11:14:59 -0700

At 08:50 AM 5/11/00 +0100, Damien Braniff wrote:

Online documentation is viewed it two ways - some see it simply as an online
version of the book, often simply in PDF format with search etc available.
Personally I don't consider this 'true' online documentation. It IS online but
is done using PDF either because it's the easiest/cheapest or because it's known
that the customer will probably print it out anyway! 'True' online
documentation, to me at least, is much more like a help file in structure than a
traditional book. One example is "Standards for Online Communication" file
provided with the book by the same name by JoAnn Hackos. The online version
contains all the information in the book but as a help file - small topics and a
TOC to allow you to easily browse the 'book'.
=============================================================
Too narrow.

Certainly, a PDF file with no links or bookmarks that is intended primarily for printing
is not an on-line document--It's just a way for the publisher or product manufacturer to
avoid the cost of printing and distribution, with (hopefully) the cost saving passed on
to the consumer. In addition to the initial cost savings, this method has two more
advantages:

1. System administrators can't confiscate the printed books and lock them away,
depriving users of access to the information.

2. Updates/revisions can be distributed quickly and economically.

But a PDF document with a multi-level collapsible TOC for bookmarks, richly supplemented by
internal and external cross-reference links, is certainly a true on-line document that has some
distinct advantages over HTML, WinHelp, RoboHelp, etc. Those advantages include:

1. If, the user does opt to print out the document or parts thereof s(he) is assured that
each page will be fully replicated.

2. PDF replicates the typography and page layouts of high-end DTPs, and it has been shown
that well-designed documents can substantially improve comprehension and retention of
complex technical information. These improvements apply to on-line reading as well as
printed-book reading.

3. Acrobat has full text search and retrieval capabilities that far exceed those available in
most other browsers.

4. Acrobat allows users to customize the zoom setting to match their individual reading
comfort needs.

5. Acrobat also allows users to zoom in to a high magnification on a section of a page. This
can be important when viewing complex illustrations.

6. A single PDF document can intermix different page sizes and orientations (e.g., landscape
and portrait orientations, as well as foldouts for schematics, flow diagrams, etc.).



====================
| Nullius in Verba |
====================
Dan Emory, Dan Emory & Associates
FrameMaker/FrameMaker+SGML Document Design & Database Publishing
Voice/Fax: 949-722-8971 E-Mail: danemory -at- primenet -dot- com
10044 Adams Ave. #208, Huntington Beach, CA 92646
---Subscribe to the "Free Framers" list by sending a message to
majordomo -at- omsys -dot- com with "subscribe framers" (no quotes) in the body.






Previous by Author: Re: Using FrameMaker AND FrameMaker+SGML?
Next by Author: Re: HUMOR: Now on Sale at the STC Bookstore
Previous by Thread: Re: PDFs and Online Documentation
Next by Thread: Re: PDFs and Online Documentation


What this post helpful? Share it with friends and colleagues:


Sponsored Ads