Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Trial and error
  • Call IT for help
  • Look at first page of information that they can find and glance at
  • Search help by keyword
  • Search using Google
  • Consult with colleague in next office, or ask office staff

4. What works in the way our documentation is organized?

...

  • FAQ: What users are asking after having used the system
  • Tasks: Based on workflows, not on tools (Setting up a course site vs. using Site Info, for instance)
  • Help files tend to be in text, other documentation might be in document, audio, video, picture format.
  •  

8. How can we encourage the Sakai community to contribute their improvement back to the OOTB help files?

  • 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

...