Creating Application User Help File

[Jasmine]

I need some assistance creating a Help File for my application so that a
user
can get instant assistance if they need within the application.

I've already documented some of the application procedures within MSWord,
but do not know if this is the right approach.

Thanks for your help

[Larry Daugherty]

Hi Jasmine,

It isn't that easy....

To document your procedures, use something like MZTools to document
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.

Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.

Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.

I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.

If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the button
that brings this message up".

HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so that a
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within MSWord,
but do not know if this is the right approach.
Thanks for your help

[Jasmine]

Larry,
Thanks for your response.
I really appreciate it.

How about a more simplistic approach like creating a
Word file and attaching as an object?

Post by Larry Daugherty
Hi Jasmine,
It isn't that easy....
To document your procedures, use something like MZTools to document
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.
Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.
Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.
I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.
If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the button
that brings this message up".
HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so

that a

Post by Jasmine
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within

MSWord,

Post by Jasmine
but do not know if this is the right approach.
Thanks for your help

[Mike Revis]

Jasmine,
If you want something "really" simplistic that will merely explain the
fields and functions on a particular form.
Like "Clicking this button will cause your computer to reboot"

Make a copy of an existing form.
Highlight the form name in the database window.
Copy the form.
Paste the form back into the database window with a different name.
Example: Copy form frmMyForm. Paste frmMyFormHelp.

Remove all of the code, recordsource etc from the help form.
Use the ControlTipText to enter the information you want to provide for a
particular field or button etc.
Place a command button on frmMyForm to open frmMyFormHelp.
The user can open the help copy of the form and by mousing over a particular
field see info about that field or button.
I'm not sure about the size limitation for ControlTipText.
You can also use labels on the help form for more extensive explanations but
that gets a little messy.

You can then watch the user try to enter data in the field after reading the
explanation <big grin>

Don't forget to put a close button on the help form.

Good luck
Mike

Post by Jasmine
Larry,
Thanks for your response.
I really appreciate it.
How about a more simplistic approach like creating a
Word file and attaching as an object?

Post by Larry Daugherty
Hi Jasmine,
It isn't that easy....
To document your procedures, use something like MZTools to document
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.
Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.
Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.
I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.
If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the button
that brings this message up".
HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so

that a

Post by Jasmine
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within

MSWord,

Post by Jasmine
but do not know if this is the right approach.
Thanks for your help

[Jasmine]

Mike,
Will this allow me to document the form as well, so as to give
specific direction
on - How to on the Form?

Post by Larry Daugherty
Jasmine,
If you want something "really" simplistic that will merely explain the
fields and functions on a particular form.
Like "Clicking this button will cause your computer to reboot"
Make a copy of an existing form.
Highlight the form name in the database window.
Copy the form.
Paste the form back into the database window with a different name.
Example: Copy form frmMyForm. Paste frmMyFormHelp.
Remove all of the code, recordsource etc from the help form.
Use the ControlTipText to enter the information you want to provide for a
particular field or button etc.
Place a command button on frmMyForm to open frmMyFormHelp.
The user can open the help copy of the form and by mousing over a
particular field see info about that field or button.
I'm not sure about the size limitation for ControlTipText.
You can also use labels on the help form for more extensive explanations
but that gets a little messy.
You can then watch the user try to enter data in the field after reading
the explanation <big grin>
Don't forget to put a close button on the help form.
Good luck
Mike

Post by Jasmine
Larry,
Thanks for your response.
I really appreciate it.
How about a more simplistic approach like creating a
Word file and attaching as an object?

Post by Larry Daugherty
Hi Jasmine,
It isn't that easy....
To document your procedures, use something like MZTools to document
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.
Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.
Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.
I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.
If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the button
that brings this message up".
HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so

that a

Post by Jasmine
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within

MSWord,

Post by Jasmine
but do not know if this is the right approach.
Thanks for your help

[Mike Revis]

Jasmine,
I'm not sure I understand the question.
If by document the help form you mean explain how to use the help form you
could use a label at the top of the help form that says something
like...."Move the mouse pointer over a field to see the instruction for that
field. Click the close button to return to the data entry form"

You can also use hidden labels that only become visible in specific
instances like mouseover something but this will drive you crazy trying to
implement.

If that's not what you mean please explain further.

Mike

Post by Jasmine
Mike,
Will this allow me to document the form as well, so as to give
specific direction
on - How to on the Form?

Post by Larry Daugherty
Jasmine,
If you want something "really" simplistic that will merely explain the
fields and functions on a particular form.
Like "Clicking this button will cause your computer to reboot"
Make a copy of an existing form.
Highlight the form name in the database window.
Copy the form.
Paste the form back into the database window with a different name.
Example: Copy form frmMyForm. Paste frmMyFormHelp.
Remove all of the code, recordsource etc from the help form.
Use the ControlTipText to enter the information you want to provide for a
particular field or button etc.
Place a command button on frmMyForm to open frmMyFormHelp.
The user can open the help copy of the form and by mousing over a
particular field see info about that field or button.
I'm not sure about the size limitation for ControlTipText.
You can also use labels on the help form for more extensive explanations
but that gets a little messy.
You can then watch the user try to enter data in the field after reading
the explanation <big grin>
Don't forget to put a close button on the help form.
Good luck
Mike

Post by Jasmine
Larry,
Thanks for your response.
I really appreciate it.
How about a more simplistic approach like creating a
Word file and attaching as an object?

Post by Larry Daugherty
Hi Jasmine,
It isn't that easy....
To document your procedures, use something like MZTools to document
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.
Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.
Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.
I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.
If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the button
that brings this message up".
HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so

that a

Post by Jasmine
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within

MSWord,

Post by Jasmine
but do not know if this is the right approach.
Thanks for your help

[Larry Daugherty]

Attaching a Word file to do what? It kinda sounds like a non-starter.

Think through why you're considering a Help file. If it's to help the
user of your application then consider what a tough job that can be.
Many users won't read ebook type help files. They just want to know
what they want right now. If you are not presenting context sensitive
help files then liberal use of the Status Bar and Control Tip Text can
combine to provide some help in context.

HTH
--
-Larry-
--

Post by Jasmine
Larry,
Thanks for your response.
I really appreciate it.
How about a more simplistic approach like creating a
Word file and attaching as an object?

Post by Larry Daugherty
Hi Jasmine,
It isn't that easy....
To document your procedures, use something like MZTools to

document

Post by Jasmine

Post by Larry Daugherty
each procedure in its code module. You do that for the benefit of
future developers who must maintain your code. Do a good job, you're
likely to be the future developer who benefits most.
Your question seems to be about creating *context sensitive* Help
files. That's a whole different animal. Help files are not a part of
Access. They are created using different processes. None are
painless.
Unless there have been new additions to the stable, Microsoft's tools
will get you there but with a lot of pain and effort. There are a
host of 3rd party tools that all hype their abilities but most are
pretty feeble. And most dance all around the fact that they don't
create context sensitive help files. Most will also require that you
have the Microsoft Help file tools on your system so don't regard that
as a failing when they reveal it.
I stopped my Help file research a few years back when I found HTML
Help.. They offer aversion that will read your MDB and create the
start of a context sensitive help file for you. Getting started is
the worst part of creating help files. Extensive application
modifications can turn the maintenance of the help file into a
nightmare.
If written with the User in mind, Help files are incredibly useful to
them. Try to keep things in a more helpful vein than the typical
Microsoft effort: "This message comes up when you click the

button

Post by Jasmine

Post by Larry Daugherty
that brings this message up".
HTH
--
-Larry-
--

Post by Jasmine
I need some assistance creating a Help File for my application so

that a

Post by Jasmine
user
can get instant assistance if they need within the application.
I've already documented some of the application procedures within

MSWord,

Post by Jasmine
but do not know if this is the right approach.
Thanks for your help

[Tony Toews [MVP]]

Post by Jasmine
How about a more simplistic approach like creating a
Word file and attaching as an object?

Why not just create a table in your FE with a memo field. For each of
your questions or help pages put that text in a new record with a memo
field. Create a form which displays that memo field.

Next to something on a form or menu that you want to document place a
command button with a question mark image. Then in that VBA code
behind the command button open the above form.

Not fancy but it works.

Tony

[Jasmine]

Thank you all for your input.

Really appreciated all the suggestions.

Make it functional , but make it simple is my motto.

Post by Tony Toews [MVP]

Post by Jasmine
How about a more simplistic approach like creating a
Word file and attaching as an object?

Why not just create a table in your FE with a memo field. For each of
your questions or help pages put that text in a new record with a memo
field. Create a form which displays that memo field.
Next to something on a form or menu that you want to document place a
command button with a question mark image. Then in that VBA code
behind the command button open the above form.
Not fancy but it works.
Tony
--
Tony Toews, Microsoft Access MVP
Please respond only in the newsgroups so that others can
read the entire thread of messages.
Microsoft Access Links, Hints, Tips & Accounting Systems at
http://www.granite.ab.ca/accsmstr.htm
Tony's Microsoft Access Blog - http://msmvps.com/blogs/access/