Daniel,
Great idea. We're working on that right now.
Only problem with creating such in-application help texts is we first have to fully document OFBiz
before we even know what to put in such in-app help texts. We're also working on that right now.
In case our full user manual is clear enough, then we might skip the work needed to build in-app
help texts.
> Finally, it seems that the instructions could be embedded into seed or demo
> data, and become part of the final user's website. This seems like it might
> work even better, but is probably the hardest to develope and configure.
I vote for this method. It's the most OOTB approach. But I don't suggest putting the help texts in
database. It's easy enough ("duh" kind of easy) to create help texts inside individual webapp/
folders.
Also, consider the case where we customize OFBiz for individual clients. Each customized OFBiz
will probably have different functionalities (tweaked/modified from original), and they'll all
require their own Help texts.
Creating a centralized Help site (say http://ofbiz.apache.org/help) will too tightly couple
individual OFBiz instances (including customized instances) to the one-size-fits-all Help site.
Jonathon
Daniel Kunkel wrote:
Hi
I've got what I think is an awesome idea for improving the end user
experience easily with page links to user documentation.
The idea is pretty simple I think... Essentially most every page of the
OFBiz web application would get an "Instruction for this Page" link.
This link would then take the user to page describing the page and how
to use it.
The implementation is a little more difficult, since I'm uncertain where
is the best place to locate the instruction.
My first thought is to create a centralized OFBiz wiki. This way the
content would be developed and improved easily by the user community as
a whole, for the benefit of everyone.
However, this doesn't conform to the style, formating, or system
modifications that may make the documents inappropriate for some
installation.
The next thought then, is to create an OFBiz sub web-site. The
formatting could be controlled by the maincss helping with the
formatting, and can be changed. However, it's much more difficult to
develop and deliver than with a wiki.
Finally, it seems that the instructions could be embedded into seed or
demo data, and become part of the final user's website. This seems like
it might work even better, but is probably the hardest to develope and
configure.
Thanks
