[Building Sakai] Context-Sensitive Documentation in Sakai

[Matthew Jones]

I think what might be better/easier would be to have that initial page of
help describe that this functionality exists (that clicking on any help
icon on any tool will bring up context sensitive help for that tool) and
also including this help button as part of the 2.9 tutorial tool.

The initial help page already has a little block which says
*"Tool Help: While using a tool, you can go directly to the Help for that
tool by clicking on the Help icon in the tool title bar "*
But it's pretty easy to miss, maybe adding the icon or something and moving
this block to the top will make people more likely to see it.

The only obvious problem I can see is that the list on the left is for
pages (not tools) and pages can have multiple tools placed on them. (Like
the home page)

Either way, as long as there's a property to preserve existing behavior it
can be merged into trunk if you wanted to go through with the change.

On Tue, Jul 31, 2012 at 10:12 AM, Chris Kretler <ckretler at umich.edu> wrote:

> Hello,
>
> Feedback from a recent student study on the usability of Michigan's local
> Sakai instance indicated that users are not aware of the context-sensitive
> documentation.  As such, they were missing documentation on important and
> complex tasks like site creation.  Currently, the 'Help' link in the list
> of tools on the left side of the interface links to general help, while the
> question mark on the right side of a tool's title bar provides access to
> context-sensitive documentation.  We are considering changing the 'Help'
> link in the list of tools so that it links to context-sensitive
> documentation.
>
> What are your thoughts on this change?  If we do make this change locally,
> do you think this should be merged into trunk?
>
> Regards,
> Chris Kretler
> Business Analyst
> University of Michigan
>
> _______________________________________________
> sakai-dev mailing list
> sakai-dev at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>
> TO UNSUBSCRIBE: send email to
> sakai-dev-unsubscribe at collab.sakaiproject.org with a subject of
> "unsubscribe"
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/sakai-dev/attachments/20120731/48dfd795/attachment.html