Tek-Tips is the largest IT community on the Internet today!
Members share and learn making Tek-Tips Forums the best source of peer-reviewed technical information on the Internet!
-
Congratulations strongm on being selected by the Tek-Tips community for having the most helpful posts in the forums last week. Way to Go!
Help files 2
- Thread starter dan9991
- Start date
-
1
- #2
FancyPrairie
Programmer
Microsoft has a free help compiler available that will help you build help files. Fairly difficult to figure out (little documentation). Check your disk for files that begin with hcw (i.e. hcw.exe, hcw.hlp). It's been awhile since I've worked with it, but I believe that I got hcwsetup.exe off the web somewhere (do a google search).
Once I figured out how to use it, it wasn't too bad. However, when I went back to edit it several months later, I had to try to figure out how to use it all over again. I have sinced purchased RoboHelp. Makes it alot easier (a little expensive though)
Once I figured out how to use it, it wasn't too bad. However, when I went back to edit it several months later, I had to try to figure out how to use it all over again. I have sinced purchased RoboHelp. Makes it alot easier (a little expensive though)
In my opinion writing help is probably the most difficult thing to do, at least for me it was. I am not referring to the technical aspect. Whatever help compilier you use will still take some learning. Organization of what you want to write and how it is outlined and related is the difficult part. If the help you want to show is somewhat simple, try using the ControlTip Text in the properties of a control. When you place the mouse over the control at least some indication will appear.
HTH An investment in knowledge always pays the best dividends.
by Benjamin Franklin
HTH An investment in knowledge always pays the best dividends.
by Benjamin Franklin
FancyPrairie
Programmer
I agree with mph1. Another problem with help files is that they are difficult to keep up-to-date. Every time you make a change to your database, you will have to remember that the help file may need to be updated. I've also found that user's seldom use the help files. And, generally, a person doesn't have time to keep user documentation up-to-date. Consequently, you can't count on it being accurate.
My last post kind of implied that I created help files for Access. Actually, I created them for other systems like our Help desk (things that don't change much).
My last post kind of implied that I created help files for Access. Actually, I created them for other systems like our Help desk (things that don't change much).
If you created a project for the hepl desk, for example, where you might be looking for help of FAQ's that don't change much, as you mentioned, maybe write someting in a word processer and enter it into your db as part of a report. It would be static, but like you mentioned who will keep it up to date, assuming someone looks at it in the first place. An investment in knowledge always pays the best dividends.
by Benjamin Franklin
by Benjamin Franklin
Sorry but I disagree help files are not that hard to create. However, you must devote the time to keep them current. I use and recommend Visage Software Windows Help Designer. It utilizes a simple user interface and stitches into your Access application rather nicely and easily. Life's a journey enjoy the ride...
jazzz
jazzz
psemianonymous
Programmer
Re: help file difficulty
He's talking about how tough it is to write proper technical documentation. And it is tough to fully, accurately and concisely disseminate information related to as dry a topic as database applications.
I think we all agree with THAT.
He's talking about how tough it is to write proper technical documentation. And it is tough to fully, accurately and concisely disseminate information related to as dry a topic as database applications.
I think we all agree with THAT.
-
1
- #8
Hi,
I have a BS in journalism, and I understand the difficulty. However, there are a few rules that can be followed.
First, make a list of topics that you wish to present to the user. Using a notepad, carry it around with you for several days. As things come to your mind, jot them down. Most likely these will become your main topic ideas.
Second, keep it simple. In other words, when creating a paragraph, limit it to a specific topic. With this single topic (or main idea), the other sentences would supply additional information or links. A perfect example of this is this same paragraph.
Third, after several paragraphs have been created, reread them carefully, then present them to the users (if possible), and get some preliminary feedback. If this is not feasible, present it to a friend or coworker for suggestions.
Fourth, write simple sentences so that you are not misunderstood. Need an example of this? Just take a look at the daily newspaper. HTH,![[pc2]](/data/assets/smilies/pc2.gif "[pc2] [pc2]")
Randy Smith
California Teachers Association
I have a BS in journalism, and I understand the difficulty. However, there are a few rules that can be followed.
First, make a list of topics that you wish to present to the user. Using a notepad, carry it around with you for several days. As things come to your mind, jot them down. Most likely these will become your main topic ideas.
Second, keep it simple. In other words, when creating a paragraph, limit it to a specific topic. With this single topic (or main idea), the other sentences would supply additional information or links. A perfect example of this is this same paragraph.
Third, after several paragraphs have been created, reread them carefully, then present them to the users (if possible), and get some preliminary feedback. If this is not feasible, present it to a friend or coworker for suggestions.
Fourth, write simple sentences so that you are not misunderstood. Need an example of this? Just take a look at the daily newspaper. HTH,
Randy Smith
California Teachers Association
Here are some principles I've used generating help documents that should add to the confusion:
1) use screen shots and image maps in the help so users can click on areas of interest and get help on it. The help compiler comes with a nice screen capture tool, and you can find the size/location of rectangles to click using the selection tool.
2) Lots of links. Not too many. But lots. Anything that looks like it may be an unusual vocabulary word.
3) Build a good index. Use the help compiler's indexing capability. I actually wound up writing a quick VC++ text processing tool to aid in the indexing process.
4) Take time to make a useful TOC as well.
5) Don't just document the properties and methods of your software, include a 'how-to' guide that will illustrate commonly used (and hopefully some not-so-commonly used) workflows.
6) Keep in mind what kind of help you've found helpful, and what kind of web-sites you find easy to navigate, and use those principles.
7) Every dialog box, form, everything accessable to the user, must be documented.
1) use screen shots and image maps in the help so users can click on areas of interest and get help on it. The help compiler comes with a nice screen capture tool, and you can find the size/location of rectangles to click using the selection tool.
2) Lots of links. Not too many. But lots. Anything that looks like it may be an unusual vocabulary word.
3) Build a good index. Use the help compiler's indexing capability. I actually wound up writing a quick VC++ text processing tool to aid in the indexing process.
4) Take time to make a useful TOC as well.
5) Don't just document the properties and methods of your software, include a 'how-to' guide that will illustrate commonly used (and hopefully some not-so-commonly used) workflows.
6) Keep in mind what kind of help you've found helpful, and what kind of web-sites you find easy to navigate, and use those principles.
7) Every dialog box, form, everything accessable to the user, must be documented.
- Thread starter
- #10
The help files will stay mainly the same as it shows the functions of a database. However i need to know what program i need and where do i start. I am to write code or will they do it for me. Thanks for the replies. Once i delt with this i will come back and give stars
Dan, I use and highly recommend Visage Software Windows Help Designer. You simply type and click very easy to use. It does a very professional help file I might add and it is inexpensive also. Life's a journey enjoy the ride...
jazzz
jazzz
FancyPrairie
Programmer
Sounds like a pretty simple help file, so I would recommend using Microsoft's Help compiler. You can do everything in Word and then run it thru the help compiler.
Hi ALL,
Personally, I use Microsoft Word to write my documentation, and then I add a command button to my form, which then uses the Hyperlink property (found under the Format tab in Properties) to open up the Word document. HTH,
Randy Smith
California Teachers Association
Personally, I use Microsoft Word to write my documentation, and then I add a command button to my form, which then uses the Hyperlink property (found under the Format tab in Properties) to open up the Word document. HTH,
Randy Smith
California Teachers Association
- Thread starter
- #14
FancyPrairie
Programmer
is where you can download a free copy of Windows Help Compiler.
I'm not sure who to address this to since there are so many people who have been helpful. I'm not sure I understand all the terminology used above, but this is the only thing I can find on the Internet addressing something close to my question. I am an office manager writing a DB which includes a ton of information on all the projects we have done. I built from there and pretty much most things I do are done through this DB. However, to make it easy on the user, I wanted a "Help" section. I built a Tab Control which each letter of the alphabet having its own control page. I put labels on each page representing words in that letter. For some words, it opens a form that relays the information/definition/explanation they need, for others I did a message box. However, I have 439 buttons needing a message box or form. That is too many forms. I was hoping someone could give me a way to do this that is not so complicated as VB is still pretty new to me. I had thought to do a Word document for each letter of the alphabet and when they made a selection, it would open the word document and put the cursor directly on their word, but I have no clue if that is able to be done and how to do it.
My goal: If I die before I wake, the person who takes over my job should be able to open this DB and everything they need to do my job is explained in the DB.
Any suggestions on how I can make this easier? Thanks for the help and thoughts, JL
My goal: If I die before I wake, the person who takes over my job should be able to open this DB and everything they need to do my job is explained in the DB.
Any suggestions on how I can make this easier? Thanks for the help and thoughts, JL
FancyPrairie
Programmer
I highly recommend RoboHelp. Very easy to use and very robust. If you are familiar with Word you won't have any problems. You can get a free demo version from their web site. The product is a little expensive, but, well worth it. In fact, with a large project, I bet you would save money by buying RoboHelp vs the manhours with something else.
Because of the success I have been having with it, we are currently investigating using it for our help desk coverage and as a central repository for all of our documentation, etc. You can link to Excel spreadsheets, Word documents, etc.
Because of the success I have been having with it, we are currently investigating using it for our help desk coverage and as a central repository for all of our documentation, etc. You can link to Excel spreadsheets, Word documents, etc.
- Status
Similar threads
