Hello

I would like to suggest that some kind of help framework should be
considered for the Meego devices.

I think it is very important to usability to have at least the basic
documentation available on the device. This documentation must not depend
on network availability to be usable. The end user should be able to click
on a help button to see a full description for all options available on
the device.

All basic features (operating system, basic configuration, etc) should
have a mandatory documentation policy. For third party applications, the
documentation framework is recommended, but it is up to the developer (or
community) to implement it.

What would be the basic characteristics or such a framework?

Here is a quick brainstorm list:

1) It should be as easily to create, display, index and show help as
possible;

2) It would be interesting to leverage existing technology or stretagies:
i.e, use html templates, implement an indexer that crawls html pages from
standard locations (just like the media player tracker, for instance),
build a central help index and some standard way of calling the external
browser to display a help page when the user requests it.

3) It should be easily internationalized;

4) There could be a wiki, or a meego web system that the community could
use to improve the documentation, help with translations and help with
general improvements and filling the gaps. This wiki or web system, would
then be exported to the proper format and added as updated packages to be
package system.

There has been some talks about this in the maemo.org. It seems that there
was a decision to drop the help system and API because of lack of usage.
However, since Meego is a new start, why don't make things properly? Maybe
it was not used because it was difficult to generate or adapt existing
documentation for it.

What is your thought on this?

Thanks,

Luis

_______________________________________________
MeeGo-dev mailing list
[email protected]
http://lists.meego.com/listinfo/meego-dev

Reply via email to