Thoughts About On-Line Help   

Shovelware is becoming the norm in computer software documentation. Many companies no longer furnish printed books with their products, and it’s usually impossible to produce (from the on-line help files) a reasonable facsimile of a coherently organized, double-sided, printed book with page numbers, running headers and footers, table of contents, glossary, and multilevel subject index. The current sad state of affairs is epitomized by the FrameMaker user manual and on-line help. In the last release (V5.1) of FrameMaker+SGML for which Frame Technology was responsible, the printed user’s manual was quite comprehensive at 900+ pages, and the on-line help was extensive, well-designed, and effective. But the Adobe-produced V5.5 user’s manual (including the separate “Getting Started” manual for FM+SGML) has 300 fewer pages, even though many new fea-tures (e.g., HTML and XML export) in V5.5 had to be covered in addition to all those features common to both releases. Not only that, but the effectiveness of the on-li

Emory, Dan. TECHWR-L (1999). Articles>Documentation>Help>Online