Writing Help Documentation

Sample help documentation - Featured image
Share this:

There are many uses for writing help documentation! For example, adding help documentation to a software application. Or, perhaps …

Over the years your company builds up solutions to problems or instructions on how to perform certain procedures. Usually these remain in an employee’s notebook and other members of staff are not aware of this knowledge.

Imagine having this information collated into one searchable knowledge base on your company network or intranet? Working procedures and standards can be collated into this knowledge base resource and it can become a consistent basis for informing staff of your procedures.

TruckleSoft can create useful help documentation by taking your notes and images and converting them into a fully-functional knowledge base. Don’t worry if you can’t provide the images because we can visit your office and use special screen capturing software to take snap-shots of all the required dialogues etc..

CHM Format

This knowledge base can be provided in a variety of formats. The image at the start of this help topic is of a CHM (Compiled HTML Help) file. This file format is useful if you want to keep all information in a single document. These files are supported by most operating systems including Microsoft Windows 7 through 10.

HTML Format

Sample Help Documentation - HTML format
Example of help documentation in HTML format

The knowledge base can also be provided in HTML format. Here is an example (click to enlarge).

The HTML knowledge base can be made available on your company intranet or exposed on the world wide web (as in the example above).

It also has features to help you get the articles noticed by search engines like Bing or Google.


Other Formats

There are other help file formats supported (it just depends on your requirements). These are:

  • ePub format
  • PDF format
  • Microsoft Word format
Note Icon

These various types of help documentation are all compiled from the same underlying data files so it is easy to maintain the knowledge base. By working together we can come up with a good knowledge base or similar to complement your working practices.

Please use the Contact Form and get in touch if this service interests you!

Scroll to Top