What is the recommended way to present a help file?

Question

It seems that I no longer know what will happen when I start the program Help. Which makes all this more confusing when you have to decide how to create a help file for my application.

For example, it can open my web browser for a local instance of an html file. This may indicate a support website. It can download Windows Help and Support Center. It can load the chm file. He can download a custom help form with menus, etc.

What is the “right” way to implement help?

I like the idea of ​​a chm file, but it's hard for me to transfer any updates to users without updating the application. The same can be said for the local html-based help file.

I also like the idea of ​​creating a web help file, as I can update it as needed with new information, but what does it mean for users who do not have an active Internet connection? For example (in my case, my software will be used the same on a car laptop without an Internet connection and on a desktop computer with an Internet connection)

I am curious to know what is usually done when creating the help file and what development tools are used, if any.

Answer 1

The solution I used for mobile applications is to have a local html help file that the application displays for help content in a web view. Then we had a background mechanism for checking the update service for help and downloading updated HTML and other static content, if necessary. Thus, you always have a local HTML file that does not require a connection, and does it quickly (since the download is not required to view it).

Answer 2

The thinnest way is to provide a compiled HTML (CHM) file.

There are many free and paid apps that help you create documentation. You can try Rahman CHM Maker or KEL CHM Creator .