Documentation


ABCDEF can structure the documentation to meet the specific needs of the end user. This user might be an engineer, technician, office staff or business associate. Documentation can be a critical step in insuring that the software is used correctly and efficiently. Several formats will allow for easy access in a variety of situations.

Final format of the documentation can be:

  • Printout
  • Source file
  • On-line help file
  • PDF file
  • HTML file

A printout can be placed near the equipment to provide a quick reference. This is the most familiar of the formats listed. Some users like to be able to grab the documentation and take it somewhere to read it.

Availability of the source file will allow the customer to determine how the information is distributed. Also, the content can be customized to suit the needs of specific situations. A company may decide to edit the document by removing technical information that the operator should not have knowledge of. Details on calibrating a sensitive piece of equipment should not be left in the hands of an untrained technician.

If the software is complex, an on-line help file will allow one click access directly into the portion of the manual dealing with the dialog box or menu. This allows the user to be back on track in seconds.

A PDF (page description file) format will allow the entire document to be read on-line with out taking up as much disk space as the original document and without requiring the source application. PDF files are small, load quickly and allow for the full document to viewed, searched or specific pages to be printed.

The HTML (Hyper-Text Markup Language) file format will allow distribution on a company's intra-net. There the users of the software will have the same direct access as other persons evaluating the potential of it's use.

Last updated on: September 26, 2011