...
| Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| 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.
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 | Institution | Expected contribution | ||
|---|---|---|---|---|
Mathieu Plourde | mathieu@udel.edu | University of Delaware | Ideas, workflows, leadership (Needs Assessment/Ideas, Standards, Editorial Board, Writing, Project Management) | |
Alan Regan | 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 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 | |
Kim Eke | kim_eke@unc.edu | University 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.
...
- Sakai Knowledge Base, managed by Indiana: https://www.indiana.edu/~sakaikb/
7. What are the difference between help files and other documentation?
...
- Provide an easily editable platform for central documentation
- Provide guidance on what should be contributed back, and how
- Provide ways to point to localized documentation to supplement the core help files
- Have a vetting process in place to accept/reject contributed changes
- Make the help files easily "subscribable", customizable, exportable in multiple formats for quick local updates
- Do we need a documentation policy? To be discussed at EuroSakai 2011.
9. How should we vet the quality of the OOTB help files?
...
- What is the difference between localization and branding?
- Good question
- I offer the suggestion that "branding" refers to the name and/or logo that an institution may give their instance of Sakai. Michigan calls their instance "CTOOLS," Indiana "Oncourse," VirginiaTech "Scholar," etc.
- Localization would refer to providing the same helpful information in multiple languages or regions, e.g. Spanish, English (UK), English (US), French, German, Chinese, Japanese, etc.
- Good question
- For "branding," can we provide definable fields. One definable field might be "brand name" that would default to "Sakai" out of the box (OOTB) but allow an institution to replace with their local instance's name. The text of the help files would either dynamically (or periodically) lookup and insert the local brand name into the help files. Similarly, a definable image source could be provided for a brand logo and placed into the help files. And definable formatting colors could also be available, which would insert the colors into the appropriate CSS and/or HTML source. (Adam: It would also be useful to have a look-up table of local tool names (unless these can be be pull in automatically from the tool definition file))
- Customization: Each institution goes into the help files and purges tools that are not used, or takes out references to a certain role, etc. It would be nice if those customizations could be easily visible to all, so that they could be integrated in your local help files.
...