Online help vs. CHM help
-
We have a technical author on staff to write our documentation. I am aware enough of my shortcomings as an author to know that the task of writing documentation is best left to a dedicated person. Sadly, I am going to have to recruit a new one because Alison has just resigned to move to a contract that's paying her £1,000 a day to write documents; I'm obviously in the wrong job,
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
So am I! :omg:
Real men don't use instructions. They are only the manufacturers opinion on how to put the thing together. Manfred R. Bihy: "Looks as if OP is learning resistant."
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
Storing Information online is more convenient and easily updatable. Users can be shown tutorials, offers, new products on web. Moreover, It is at ease of click with no downloading, which is usually blocked in most corporate networks. So, Choice of Web as Help Page is better. :)
// ♫ 99 little bugs in the code, // 99 bugs in the code // We fix a bug, compile it again // 101 little bugs in the code ♫
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
If your product can only be used online then online help is the way to go, it will give you better maintainability and you can avoid individual deployment issues. You need to make sure all users are on a acceptable bandwidth to use the online help. If your product can be used in offline mode then I would say follow the MSDN way where a user can opt for offline help. In any case using a pre-compiled CHM or HTML help will be my last option.
WJFK (Write Just for Kicks)
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
I prefer to use a CHM or HLP file personally. I've too many experiences with trying to use software in which the help option links to some website whose link is broken. Also you never know whether the pages on there represent the version of the software you are using and might have reasons to not want to run the latest version. I think there are issues with CHMs in later versions of Windows though, I seem to remember MS blocking them at some point and some workaround you have to do to allow them again.
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
I would provide both: - an initial chm file - online help, which you can compile to a chm file that you provide as a download from the web site, so that the sync between latest chm version and online version is guaranteed. A lot of people still like to work offline, and some search functionalities are still easier to use and quicker offline
-
We have a technical author on staff to write our documentation. I am aware enough of my shortcomings as an author to know that the task of writing documentation is best left to a dedicated person. Sadly, I am going to have to recruit a new one because Alison has just resigned to move to a contract that's paying her £1,000 a day to write documents; I'm obviously in the wrong job,
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
-
In my project I have used CHM. Its more flexible to use CHM.
Prasanta_Prince wrote:
In my project I have used CHM. Its more flexible to use CHM.
What do you mean? What can you do with CHM that you can't do with online help?
Best wishes, Hans
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
Then go for the best option: CHM files available to be downloaded in the web site just to be sure that the information will be available in the computer it will be needed only by installing it... some times there is not an internet connection there... AND Online help system. To get access to the newest and more accurate information. :thumbsup:
[www.tamelectromecanica.com] Robots, CNC and PLC machines for grinding and polishing.
-
Prasanta_Prince wrote:
In my project I have used CHM. Its more flexible to use CHM.
What do you mean? What can you do with CHM that you can't do with online help?
Best wishes, Hans
Personally I find them easier to search, and there's a standard way of doing table of contents and things. The "What's This?" is also a nice feature though I don't think MS supports it anymore (I haven't seen it on any applications for years anyway).
-
We have a technical author on staff to write our documentation. I am aware enough of my shortcomings as an author to know that the task of writing documentation is best left to a dedicated person. Sadly, I am going to have to recruit a new one because Alison has just resigned to move to a contract that's paying her £1,000 a day to write documents; I'm obviously in the wrong job,
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
You have the lovely Miss P or is this another Alison?
Panic, Chaos, Destruction. My work here is done. or "Drink. Get drunk. Fall over." - P O'H OK, I will win to day or my name isn't Ethel Crudacre! - DD Ethel Crudacre Have a bit more patience with newbies. Of course some of them act dumb -- they're often *students*, for heaven's sake. -- (Terry Pratchett, alt.fan.pratchett)
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
Honestly, I consider good ol' HLP files superior to all subsequent help formats. As years passed, I embraced many technologies, but CHM help files and Visual Studio Help VIewer weren't among them. (Microsoft's documentation, i.e., the content, is not that bad itself, but it used to be better as well.) Why make things more complicated than they need to be? Hosting the documentation online is an interesting possibility, but that depends on whether it best fits the needs of his clients.
Eduardo León
-
Pete O'Hanlon wrote:
£1,000 a d
Is this for Inside Bespoke Software, or a desktop app for the masses?
Software Kinetics - The home of good software
Inside bespoke.
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
-
You have the lovely Miss P or is this another Alison?
Panic, Chaos, Destruction. My work here is done. or "Drink. Get drunk. Fall over." - P O'H OK, I will win to day or my name isn't Ethel Crudacre! - DD Ethel Crudacre Have a bit more patience with newbies. Of course some of them act dumb -- they're often *students*, for heaven's sake. -- (Terry Pratchett, alt.fan.pratchett)
This is another Alison.
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
As already noted, quality is the key, not format. A well-written manual on clay tablets will beat the majority of online help out there. The content focus of online help has shifted in the last decade: Users expect to explore your solftware, and will look for the manual only when they are stuck, more interested in "How to solve X" types rather than understanding your software.
IMO the main downside of CHM is that browser navigation is constantly improving, and users adopt well, whereas the CHM viewer is stuck in the '90. The most significant difference is probably in full text search. Updating Help online is a two-edged sword, as you should preserve existing URL's and content for previous versions. That's no problem only for some software. CHM also offers additional features such as QuickHelp, which may come handy if you want to localize documentation. Still, I prefer a local help as long as it works (i.e. unlike MSDN). Even with a good connection, latency is slightly higher.
FILETIME to time_t
| FoldWithUs! | sighist | WhoIncludes - Analyzing C++ include file hierarchy -
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
If this is a desktop app, what if the user doesn't have an internet connection? No connection, no help. Believe it or not, this is the usual case in my environment. Given that both use HTML as a source, it shouldn't be that hard to make both available.
Software Zen:
delete this; -
We have a technical author on staff to write our documentation. I am aware enough of my shortcomings as an author to know that the task of writing documentation is best left to a dedicated person. Sadly, I am going to have to recruit a new one because Alison has just resigned to move to a contract that's paying her £1,000 a day to write documents; I'm obviously in the wrong job,
Forgive your enemies - it messes with their heads
My blog | My articles | MoXAML PowerToys | Mole 2010 - debugging made easier - my favourite utility
Pete O'Hanlon wrote:
£1,000 a day
:wtf: I wonder if I even want to know what kind of documents are these...
FILETIME to time_t
| FoldWithUs! | sighist | WhoIncludes - Analyzing C++ include file hierarchy -
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
Though I am only a student, in my experience, I have preferred CHM help files to online help files for the reason that I am not always around an internet connection, or have my connection limited to a very few number of sites. This has been my case with learning Python, and if it was not for the CHM documentation, I would not have been able to learn much of what I currently know.
-
Prasanta_Prince wrote:
In my project I have used CHM. Its more flexible to use CHM.
What do you mean? What can you do with CHM that you can't do with online help?
Best wishes, Hans
...use it on ships with no Internet access? Most of my applications are used in areas where there is no, or very limited Internet access - either limited by bandwidth or firewalls. So, chm is still a necessity to me. Which brings up the next question - any decent apps to make chm help files? I am currently using RoboHelp but that hasn't been supported since 2004. It would be nice to find something not horribly expensive but similar in operation to RoboHelp. RoboHelp could also do online help as well, from the same source.
-
My client asked me for a recommendation about whether his new product should use online help (hosted on his web site), or a traditional CHM help file. Obviously online help can be updated more easily, with no downloads involved. And sometimes CHM help files have to be "unblocked" before they can be viewed. Aside from these things, does anyone have any experience with online help for a product? Any problems with it?
Best wishes, Hans
Yes, I prefer Local PDF file's with a url to get updates. I beleve no wants to read information about the whole world, just the basic infoemation as to what this program does and and how to do it. F1 Help ( *.hlp, *.cmp or *.dbf ... files) is great for reminders.
cprich
-
Then go for the best option: CHM files available to be downloaded in the web site just to be sure that the information will be available in the computer it will be needed only by installing it... some times there is not an internet connection there... AND Online help system. To get access to the newest and more accurate information. :thumbsup:
[www.tamelectromecanica.com] Robots, CNC and PLC machines for grinding and polishing.
HTML files don't need to be "online". I use them as a standard even when provided locally with the application. CHM files allow for better out-of-the-box printing options, contents and searching, but this can be done for local HTML files as well, using an appropriate application (we use xsd, xsl and css files I wrote myself for generating the HTML table of contents).
