[Building Sakai] [sakai-docs] Fwd: Sakai 10 online help documentation update

Sam Ottenhoff ottenhoff at longsight.com
Thu Apr 10 09:53:08 PDT 2014


This is a quick heads-up that I plan on wiping out all existing help files
in Sakai trunk in the next 24 hours or so with new help files written by
our Documentation Work Group.  I will be committing against this parent
JIRA issue:

  https://jira.sakaiproject.org/browse/SAK-26054

I will be making a couple of tiny changes to the help tool CSS, but the
primary changes are all content-related.  The new documentation is broken
up into "books", one for Students and one for Instructors, and makes
extensive use of annotated screenshots.

If you have any concerns or questions, please let me know.

--Sam


On Tue, Apr 8, 2014 at 11:55 AM, Wilma Hodges <wilma at longsight.com> wrote:
>
> Hi All,
>
> This message is a follow-up update on the status of the Sakai 10 Help. To
date, the Documentation Work Group has completed 300 new help articles
using the Screensteps collaborative authoring tool. The OSP documentation
has also been incorporated into Screensteps, adding another 90 articles to
the total documentation set. Many thanks to our dedicated planning team
members and the group of ten authors who helped to create the content.
>
> All of the new documentation has been exported to HTML and Sam Ottenhoff
is working importing it into the Sakai 10 Online Help Tool. PDF versions of
the Instructor, Student, and OSP user guides will also be included in the
Online Help for users to download if they wish. The newly imported Online
Help will be committed to trunk soon. In the meantime, you can preview the
documentation on the Apereo Screensteps site:
https://sakai.screenstepslive.com/
>
> Additional documentation development is ongoing, and we welcome your
input. We currently plan to add an Administrator guide, as well as help for
additional Contrib tools and translations for other languages. We are
looking for volunteers to assist with those efforts, so if you would like
to get involved, please let us know!
>
> Willma
>
> Wilma Hodges
> Director of Training & eLearning Initiatives
> Longsight
> wilma at longsight.com
> www.longsight.com
>
>
> ---------- Forwarded message ----------
> From: Neal Caidin <neal.caidin at apereo.org>
> Date: Fri, Feb 28, 2014 at 9:06 AM
> Subject: [sakai-docs] Sakai 10 online help documentation update
> To: "sakai-docs at collab.sakaiproject.org" <
sakai-docs at collab.sakaiproject.org>, "sakai-pmc at collab.sakaiproject.org" <
sakai-pmc at collab.sakaiproject.org>
>
>
> [sakai-docs and sakai-pmc]
>
> Hi All,
>
> You might remember that we are doing a pilot of Screensteps.com for
> collaborating on the production of Sakai 10 online help documentation,
> which will then be pulled into the existing and familiar Sakai context
> sensitive online help tool. The first step is content creation and this
> part is going extremely well. Wilma Hodges is leading the documentation
> team which is on track to complete the content by March 14. Kudos to our
> documentation team!
>
> In the near future, probably after March 14, we will make the online
> documentation site open for anyone to see and comment on. If you would
> like to take a look now, please let me know and I can set you up with a
> Reader account. A Reader account is exactly what it sounds like, you are
> able to read and review, but not author, documents. AFAIK we have no
> limit on the number of Reader accounts.
>
> I'll be checking soon with our international community if anybody is
> interested in doing a translation.
>
> Here are the detailed statistics on the state of completion of the Sakai
> 10 Instructor and Student Guides.
>
> 246 total articles
> 136 approved
> 19 need review
> 6 need update
> 85 need content
>
> As an added bonus, Janice Smith had existing documentation for OSP which
> she was able to copy and paste in to a separate document.
>
> Please let me know if you have any questions.
>
> Cheers,
> Neal
>
> --
> Neal Caidin
> Sakai Community Coordinator
> Apereo Foundation
> neal.caidin at apereo.org
> Skype me! (but let me know in advance for the first interaction) -
nealkdin
>
> _______________________________________________
> sakai-docs mailing list
> sakai-docs at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/sakai-docs
>
>
> _______________________________________________
> sakai-docs mailing list
> sakai-docs at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/sakai-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/sakai-dev/attachments/20140410/3d896651/attachment.html 


More information about the sakai-dev mailing list