Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Section
Column
width25%
Panel
borderColor#83da87
bgColor#FFF
titleBGColor#83da87
borderStylesolid
titleContent ReviewborderStylesolid

2011-2012 Lead(s): Rebecca Darling, Alan Regan
2010-2011 Lead(s): Mathieu Plourde, Alan Regan, Elizabeth Venstra

Focus: Content

Short description: Review and revise the built-in help documentation within the existing tool. Look at text for accuracy and completeness, review layout and formatting, and keep the end-user in mind.

Scope: Limited to tool-based, how-to documentation at this time.

Current Project Page: Help Files 2.9 Content Project
Past Project Page: Help Files 2.8 Project Home

Column
width25%
Panel
borderColor#3fd4ff
bgColor#FFF
titleBGColor#3fd4ff
borderStylesolid
titleLocal Customization
borderStylesolid

Lead(s): TBD

Focus: Technical

Short description: Review how institutions can easily export and customize the existing help content for their unique communities. Investigate what changes can be made to the coding of the existing help pages to enable rebranding options. Discover tools or methods to extract the content and produce customized output for institutions that adopt Sakai.

Scope: TBD

Project Page: Help Files Local Customization Project

Column
width25%
Panel
borderColor#f5c73a
bgColor#FFF
titleBGColor#f5c73a
borderStylesolid
titleNew Help Tool DevelopmentborderStylesolid

Lead(s): TBD

Focus: Technical

Short description: Review the needs of the community to develop an improved help tool within Sakai. Discover and define the features and capabilities that will enable end-users to quickly search for and use relevant help information.

Scope: TBD

Project Page: TBD

Column
width25%
Panel
borderColor#b77bdd
bgColor#FFF
titleBGColor#b77bdd
borderStylesolid
titleInternational Language VersionsborderStylesolid

Lead(s): TBD

Focus: Content/Technical

Short description: Assist the community in identifying partners or tools to provide multiple language support for the built-in help files of Sakai.

Scope: TBD

Project Page: TBD

Info

Currently working on targeted review and improvements to Sakai 2.8 help files.

Latest Conference Call June 29, 2011.

A conference call was held January 19. See notes.

A first conference call was held. See notes.https://sas.elluminate.com/m.jnlp?password=M.8BD62DED7684B09FFA8A85473A0039&sid=2009099

It has now become clear that the Sakai out of the box (OOTB) help files are suffering from a lack of attention. This everlasting issue has been lingering for the longest while, with bursts of interest occurring here and there, as the following links demonstrate (this list is incomplete, please add yours):

...

Recent threads on the "Sakai User" list has generated interest in this process. It's now time to walk the talk.

Who's Interested?

...

Name

...

Email

Note: Discussion on this topic occurs primarily on the documentation@collab.sakaiproject.org mailing list. To subscribe, go here: [http://collab.sakaiproject.org/mailman/listinfo/documentation]

Who's Interested?

Name

Email

Institution

Expected contribution

Mathieu Plourde

mathieu@udel.Alan Regan

alan dot regan at pepperdine dot edu

Pepperdine University of Delaware

Ideas, workflows, leadership content (Needs Assessment/Ideas, Standards, Editorial Board, Writing, Project Management) Alan Regan

alan dot regan at pepperdine dot edu

Pepperdine University

Ideas, workflows, content (Needs Assessment/Ideas, Standards, Editorial Board, Writing)

Lorie Stolarchuk

lorie@uwindsor.ca

University of Windsor

Pain points of current situation, integration joys/woes of Brock's MediaWiki, ideas (time permitting )

Robin Hill

hill@uwyo.edu

University of Wyoming

Content, editing... whatever I checked on Alan Regan's form (Standards, Editorial Board, Writing)

Sean Keesler

sean.keesler@threecanoes.com

Three Canoes

Project Management, Writing, Workflows, Editing

Matt Clare

Matt.Clare@BrockU.ca

Brock University

We're more than happy to share our documentation at http://kumu.brocku.ca/sakai A lot of MediaWiki experience. Big advocate of ease-of-edit and radical trust.

Greg Doyle

 

University of Cape Town

Writing

Margaret Wagner

mwagner@umich.edu

University of Michigan

Ideas, Writing

Trisha Gordon

psg3a@virginia.edu

University of Virginia

Content, editing, ideas

Kara Stiles

kstiles@rsmart.com

rSmart

Content, Writing

Rafael Morales

rmorales@udgvirtual.udgd.mx

University of Guadalajara

Localization

Adam Marshall

adam dot marshall at ox.ac.uk

Oxford uni

content (& video scripts)

Matt Schneider

matt.schneider@jhu.edu

Johns Hopkins University

Content creation, Editing, ideas

Whitten Smart

ws15@txstate.edu

Texas State University - San Marcos

Ideas, Writing, Editing

Amber D. Evans

adevans@vt.edu

Virginia Tech

Ideas, workflows, leadership (Needs Assessment/Ideas, Editorial Board), CONTENT/WRITING, Styleguides/Standards (templates, XML, etc.).  I developed all of the customized documents (many for more advanced Sakai users) on the OLCS web site at http://www.olcs.lt.vt.edu/scholar/scholarHandoutsAutoIndexer.html

Jon Hays

jonmhays@media.berkeley.edu

UC Berkeley

Ideas, content, accessibility

Clay Fenlason

clay.fenlason@et.gatech.edu

Georgia Tech

Content, editing, Sakai OAE

Jeff Ziegler

ziegler@umich.edu

University of Michigan

Workflows, Writing, Editorial Board, Needs Assessment/Ideas

Sonette Yzelle

syzelle@unisa.ac.za

University of South Africa Yzelle

syzelle@unisa.ac.za

University of South Africa

Ideas, writing & editing

Barb Kerns

brk@bradley.edu

Bradley University

Writing, Editing.  We have a custom documentation site (in Drupal) at http://sakaihelp.bradley.edu.

Kerrie Stephenson

kerrie.stephenson@hull.ac.uk

Hull University

Ideas, writing, editing

Patrick Lynch

p.lynch@hull.ac.uk

Hull University

Ideas, writing & , editing

Barb Kerns

brk@bradleyKim Eke

kim_eke@unc.edu

Bradley University
Writing, Editing.  We have a custom documentation site (in Drupal) at http://sakaihelp.bradley.edu. of North Carolina at Chapel Hill

Ideas, writing, editing

Some areas of contribution to consider: Project Management, Needs Assessment/Ideas, Accessibility, Standards, Editorial Board, Writing, Programming/Development, Workflows, Localization (Internationalization/Translation), Screenshots/Videos.

...

7. What are the difference between help files and other documentation?

...