How to create a User Manual

[JoeFRB]

I'm making an inventory database with MS Access XP. I would like to know if there are any good templates or formats for creating a user manual.

The manual would contain instructions on how to use the database.

Any help would be great.

Thanks,

-Joe

 

[psemianonymous]

There's a few threads about this topic in the various Access forums, and pretty much everyone has similar opinions. One quick guide to user documentation that I 100% agree with is the following:

---
No truly sane developer enjoys writing user documentation. This is a short note about fulfilling your obligation to write technical support documentation.
---

http://secretgeek.net/TechSuppDocs.asp

 

[pweegar]

How savy are your intended users? You could write your own. Use lots of pictures. Create an image of a screen by pressing the alt + Print Scrn keys. Then paste this image into your manual. Then describe what needs to be done on each screen. The more detail you include the better. Esp. if your users don't have to many clues as to what they are supposed to do.

 

[ceh4702]

I used a lotus notes document database to make a manual for our mainframe CICS system. Of course you could learn how to make the microsoft type of Help File with a searchable index. Depends if you want a book style with chapters and sub categories that is heirarchical or what.

One problem you might see is there may some employees who should not have access to certain information like salaries and some who need only view information and some people who need both view and update information.

If you do not like my post feel free to point out your opinion or my errors.

 

[bitmite]

when I create user manuals I use the system just how a user is suppose to use the system and write every thing down (don't forget the little things) then look at that and try and find similar steps and seperat them out the be explained once. through the hundreds of user manuals I have made clients say nothing is more enoying then haveing the same or similar step explain repeatedly through out the manual.


Brought to you By Nedaineum
The Portal to Geek-tum