[Using Sakai] wiki links

[Robin Hill]

We -- at least, as represented by me -- will take the general suggestion under advisement, the general suggestion being that such tasks should be documented in the Help files.

I find, however, that the Wiki info page you cite, suggested by Adam Marshall, does indeed document the "link" macro and its parameters, in the "Summary of All Macros" list at the end.  Which is the same page as the embedded Wiki help that appears in the Edit option under "Notation Help - Full Help Page."  But neither of these pops up in the Help files proper.  You want something more immediately visible and relevant than these other sources, right?

One pesky issue raised is where comprehensive and user-driven workflow documentation should come from.  I believe that the commitment, and resources, of the KB staff at Indiana extends only to maintaining the minimal Help files supplied by developers of the tools, which are usually tool-oriented.  The ideal situation would be context-sensitive help at a fine-grained level, anticipating the user's steps, so that a he or she can find exactly the right answer to exactly the current question, under a tool tip, say... the dream of software users everywhere.  :-)

If anyone can provides suggestions on a policy and method for handling this problem, the Documentation committee would like to hear them.  Meanwhile, we rely on the community to formulate issues and report them to us via the Confluence page.  Mr. D'Arcus, I have added yours (my account of it) as you request.

--
  Robin K. Hill, Ph. D.      Coordinator of Instructional Computing, University of Wyoming
  http://www/uwyo.edu/ctl
  [On professional leave, 2010-2011]
  hill at uwyo.edu        307-760-8508   http://www.uwyo.edu/HILL
________________________________________
From: Bruce D'Arcus [bdarcus.lists at gmail.com]
Sent: Friday, January 28, 2011 2:59 PM
To: Robin Hill
Cc: Matthew Jones; sakai-user User
Subject: Re: [Using Sakai] wiki links

On Thu, Jan 27, 2011 at 7:30 AM, Robin Hill <Hill at uwyo.edu> wrote:
> What a great suggestion (re Help files).  And we'd like a few more of those.
>
> The documentation ad-hoc group-- at least as represented by me-- invites you to add to our page, "Documentation Issues to Serve as Motivation," so that we have a collection of such questions for guidance.
>  https://confluence.sakaiproject.org/display/ESUP/Documentation+Issues+to+Serve+as+Motivation
>
> In order to filter out the documentation issues that arise from not actually reading the documentation, I've included a column asking which doc sources you've already checked.

Thanks Robin.

I've been complaining about the issue tracking infrastructure of Sakai
elsewhere (WRT to OAE), but I have to say, this sort of thing doesn't
exactly encourage me to spend my limited time contributing a report.

Can I perhaps just ask you to note my suggestion, in whatever way
works for your team, that it'd be nice to include information about
the link macro in this document:

<https://weblearn.ox.ac.uk/access/wiki/site/info/local-wiki-help.html?breadcrumb=0>

... such that it gets distributed in the release help docs?

Bruce