Documentation


Tags:

CMS: Joomla!

Thursday - 1:45pm - Thursday - 2:45pm

Room:
room 3

Description:

What is documentation? Why do we go through the often painful process of writing it? Does anyone ever read it?

This session will take a radical look at the nature of documentation and why it needs to play a central role in open source projects in the future.

By deconstructing the needs of various users (consumers) of documentation, the capabilities of various producers (developers and writers) and the constraints of technology, resources and time, a model of documentation is constructed which emphasises flexibility and re-usability.

Lead by:


Tags:

CMS: Drupal

Friday - 11:30am - Friday - 12:30pm

Room:
room 4

Description:

Everywhere you turn, people talk about the shortage of Drupal talent. There are various groups dedicated to regional meetups, Drupal camps, even formal training events. The Drupal Dojo group answer the talent shortage by creating an online community dedicated to transferring knowledge from existing experts in the community to newbies who want to learn:

http://groups.drupal.org/drupal-dojo
http://www.drupaldojo.com

Lead by:


Tags:

CMS: Drupal, Alfresco, Any

not scheduled

Description:

This session is for the various CMS projects to share their own general documentation best practices strategies. What works? What doesn't? What are we doing well, and what can we do better?

Topics might include something like:

  • How to balance a low bar to user participation with quality/clarity of documentation?
  • How to both define and write for all your target audiences?
  • The great debate: wikis or structured handbooks?
  • What to do with old / out-dated documentation?
  • What to do with documentation for a new version of your product?
  • Lead by: