User manuals and help

If anyones actually tried to do anything useful with V-Script you’ll probably have found it pretty confusing, mainly due to the way it assumes you actually know what you’re doing. Now I really need a user manual to go with it to explain how to actually work the thing.

So far I’ve come up with a few main sections:

  • Quick start. Really simple, step by step guide to doing something really basic to get someone started.
  • Tool overview and concepts. Ideas behind the system, general high level description.
  • Mode docs. VScript works in one of three modes. This gives a description of each and what each does.
  • Global controls. Description of controls avalible in all modes (like most of the menu items).
  • FAQ. Suggestions welcome!

Does this seem reasonable? Any major sections that I appear to have missed out?

I’m probably going to write it in HTML, as I seem to remember there being a HTML Swing widget i can hijack to display it as a help panel (or would it be better to launch the users browser?). Is there some other, better method I should be doing this by?

Thanks

The Swing HTML widget is excellent for this sort of thing, if a little awkward to code for.

Cas :slight_smile: