[sakai2-tcc] Sakai Documentation: The Intended Scope of the Help Files

[Regan, Alan]

Hi, Robin.

I have written some notes separately and will share feedback tomorrow.  I am also reviewing Elizabeth Venstra's great feedback/information so I can reply to her email.

More soon!

Sincerely,

Alan Regan, MFA
Manager, Technology and Learning
Information Technology
Pepperdine University
(310) 506-6756


-----Original Message-----
From: Robin Hill [mailto:hill at uwyo.edu]
Sent: Wednesday, February 16, 2011 4:28 AM
To: Regan, Alan
Cc: Sean Keesler; mathieu at udel.edu; sakai-documentation at collab.sakaiproject.org; sakai2-tcc at collab.sakaiproject.org
Subject: Sakai Documentation: The Intended Scope of the Help Files

Here's my first draft of the "Help Files Scope."  As discussed in the
round of msgs below, I believe that improving the documentation of Sakai
must start with a firm, and official, agreement on just how far the KB
should go.

Pls send suggestions to documentation group...  currently led by Mathieu
Plourde, correct?

====
The Sakai Knowledge Base is a set of files displayed via the CLE Help
button that provide immediate procedural guidance, tool-based, to
end-users in "maintain" and "access" roles, with respect to the Sakai
instance running.  Information contained therein covers the normal cases
and workflows aimed at standard daily tasks.  The files are managed by
Indiana but written and maintained by the institution contributing the tool.
====


On 09/02/2011 18:22, Regan, Alan wrote:
> Thanks, Robin!
>
> Sincerely,
>
> Alan Regan, MFA
> Manager, Technology and Learning
> Information Technology
> Pepperdine University
> (310) 506-6756
>
>
> -----Original Message-----
> From: Robin Hill [mailto:hill at uwyo.edu]
> Sent: Wednesday, February 09, 2011 6:05 AM
> To: Regan, Alan
> Cc: Sean Keesler; mathieu at udel.edu
> Subject: Re: Documentation Conf Call Today?
>
> Sounds very reasonable!
>
> But I still think that we need some consensus on scoping for the Help files.
>
> "The Knowledge Base files, those documents presented via the Help button
> on Sakai user pages, are intended to serve ___ purpose for ___ user
> group..."
>
> See what I mean?  Since I'm the one who keeps bringing this up :-) I
> will try to draft a little statement myself, for submission to the
> documentation committee.
>
>
> On 04/02/2011 16:38, Regan, Alan wrote:
>> Hi, Robin.
>>
>> It was just Sean and myself on the call this week.  The basic notes:
>> (1.) Elizabeth Venstra is the main contact for IU KB items.  I will follow up with her on that.
>> (2.) Seth T. is the contact for the TCC. I am reaching out to Seth for coordination on 2.8.x branch updates to the help files.
>>
>> Mathieu has been gracious enough to volunteer to serve as TCC point of contact in March.  I'm filling in for Sean in February since he has a new, big project (big congrats to Sean!).
>>
>> Next steps (me):
>> (1.) Write the doc teams and check in on any progress or issues.
>> (2.) Flesh out styleguide thoughts.  Propose basic principles (Simple and helpful; no technical jargon; active, active, active) and additional thoughts for all members to review and amend/approve.
>> (3.) Schedule call with you to push forward with T&Q docs.
>> (4.) Schedule next group conf. call in Feb.
>> (5.) Reach out to Elizabeth Venstra.
>> (6.) Reach out to Seth Theriault.
>>
>> Next steps (Sean):
>> (1.) Verify that it's okay to keep using the Sakai 3 conference line for the meantime.
>>
>> Sound reasonable?  Am I missing anything?
>>
>> -- Alan
>>
>> ________________________________________
>> From: Robin Hill [robin.hill at oucs.ox.ac.uk]
>> Sent: Friday, February 04, 2011 5:08 AM
>> To: Sean Keesler
>> Cc: Regan, Alan
>> Subject: Re: Documentation Conf Call Today?
>>
>> On 02/02/2011 12:50, Sean Keesler wrote:
>>> Yep
>>>
>>>
>>> On Wed, Feb 2, 2011 at 7:45 AM, Robin Hill<Hill at uwyo.edu>    wrote:
>>>> Sean, I asked Alan Regan, but I think that you are the lead.  Do we have a meeting today?  Confluence page says 1400 EST.
>>>>
>>>> (Which is 1900 my time.)
>>>>
>>>>
>>>> --
>>>>     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
>> Sorry I missed it!  Couldn't get a bus early enough.  Any minutes
>> online??  Don't see any.
>>
>> Must go back to States for aunt's funeral, from Saturday to Monday.
>> Sean, I'll be in Syracuse!  At the EconoLodge on Erie Blvd, and at May
>> Memorial Unitarian Church.  Can't remember if you still live in Syracuse.
>>
>> Too bad I won't be in Alan's territory, as we seem to be having a
>> terrible time scheduling a call.
>>
>> --
>>      Robin K. Hill, Ph. D.      Coordinator of Instructional Computing,
>> University of Wyoming
>>      [On professional leave at Oxford, January - June, 2011;
>> robin.hill at oucs.ox.ac.uk]
>>      hill at uwyo.edu             http://www.uwyo.edu/HILL
> --
>      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
>


--
   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