OnLine Documentation

1
OnLine Documentation

• An Overview

2
What is online documentation?

• Any documentation delivered electronically
• Means different things to different people
• Covers a broad range of formats
• Differs in substantial ways from print
  documentation

3
Primary Formats

• PDF Portable Document Format
• Help Systems (WinHelp, HTMLHelp, etc.)
• Web Pages/Web Sites
• The Technology is Always Changing!

4
General Advantages

• Instant access to information
• Hyperlinks
• Context sensitivity
• Searchability
• Doesnt use desk space

• Lower production costs
• Easier updates
• Easier distribution

5
General Disadvantages

• Not browsable
• Tied to computer
• Uses screen real estate
• Requires computer literacy
• Doesnt provide context

• Requires joint effort between programmer and
  writer (for context-sensitive help)
• May appear cheaper (customer gets less for their
  money)

6
PDFs Electronic Books

• Advantages
• Easily cross-referenced through hyperlinks
• Easily printed
• Easily navigated
• Familiar
• Layout/format controlled

• Disadvantages
• Requires additional software (free Reader)
• Limitations on hypertext
• Large file sizes
• Requires a lot of screen real estate

7
HTML-based Help Systems

• Advantages
• Browser-based navigation
• HTML features (graphics, Java, dynamic text,
  etc.)
• Context sensitivity, Table of Contents, Index,
  and Search functions

• Disadvantages
• Look controlled by browser/monitor
• Requires IE
• Tied to program

8
Web Sites

• Advantages
• Not directly tied to program

• Disadvantages
• Requires live Internet connection

9
Help-Authoring Tools (HATs)

• RoboHelp/RoboHTML
• WebWorks Publisher