spacer arrow  Navigation
Help Files
 

Help Files are topical, procedural or reference information delivered through computer software and designed to give assistance in the use of software applications or operating systems. They can also be used to present information on a broad range of subjects. The help file is the first educational resource made for a software application. 

Help Authoring Tools
In order to create a help file, you need a Help Authoring Tool. This software provides the conversion process to turn HTML content into a single indexed, searchable file.
 
Vincent Clark is competent in the use of Microsoft Compressed HTML Help (.CHM) Help Authoring Tool. It is based on compiled HTML and other data such as images and JavaScript. In 2006, this is the current standard available from Microsoft as HTML Help 1.4. This is Microsoft's proprietary platform for delivering Help Systems in the Microsoft Windows operating system. It is provided as a free download here.
 
 
Help Projects
 
Software developers routinely need assistance in creating and improving their Help Files. Small companies cannot afford a full-time Help File Writer. A Help File project can be contracted to a specialist and represents a short-term endeavor. Many skills are required for the creation of a help file:
  • Language Skills - To provide succinct instructions and information which can be understood by the novice software user
  • Technical Skills - To learn and understand the principles and capabilities of the software for maximum benefit
  • Organizational Skills - To provide a comprehensive table of contents in a hierarchical format for quick overview and to lay out each page with logical organization for complete understanding
  • Artistic Skills - To create visually pleasing pages with images and variations in formatting which also impart knowledge
  • Educational Skills - Experienced educators understand the learning process and are patient when providing instructions to learners. Help files are those instructions - one educator removed.

Marketing and Help

The success of your software often depends on how easily new users can learn how to use it. Many people often become frustrated when the help file does not tell them why a particular software feature is there.
  • The Help File needs to explain:
    • Each feature of the software
    • Why it exists
    • How different parts of the software work together
    • How to perform a task
    • While giving visual cues for practicing a new procedure
  • The best software has the best help files. Good help files are:
    • Well organized
    • Logical
    • Hierarchical
    • Comprehensive
    • Easy to follow
    • Cross-linked
    • Indexed
    • Searchable
    • Scanable
Below are some screenshot examples illustrating a few of these features for good help files.
  
 
 
Well Organized Help File with Hierarchical Table of Contents
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Index for browsing topics  
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Visual instructions within screenshot
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Hyperlinks for rapid navigation
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Explanations for each of the text fields
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Hyperlinks to related topics
 
For help files created by an experienced computer user, teacher, and writer contact Vincent Clark.
 		 
Back To Top
PRINTABLE VIEW
TELL A FRIEND
ADD TO FAVORITES
Copyright ©2008 Tesseral Tyme - All Rights Reserved