Documentation Team/Getting Involved

Team Home   ·   Join   ·   Contacts   ·   Resources   ·   FAQ   ·   Roadmap   ·   To Do   ·   Meetings

Users Manual

The weakest link in many open source software projects is documentation. Writing effective documentation is hard. Rather than attempting to start from scratch creating our own documentation team, Sugar Labs has chosen to work with with FLOSS manuals to create the Sugar user documentation.

In many Open Source Software Projects, writers struggle valiantly in an environment that is designed to produce code not prose. FLOSS Manuals is a community of writers who create documentation for Free and Open Source Projects. Acknowledging that fact, we encourage interested contributors to become involved in the FLOSS Manual community rather then contribute directly to Sugar Labs user documentation.

Their excellent getting started guide is at OLPC simple.

Works in progress are listed in the DocumentationTeam/KnowledgeBase .

WIP

Currently, there are various 'works in progress' that we would like to combine into the definitive guide.

• http://wiki.sugarlabs.org/go/Getting_Started
• http://wiki.sugarlabs.org/go/User:Walter/sandbox/Home
• wiki.sugarlabs.org/go/DocumentationTeam/User_Manual
• OLPC Publications in the OLPC Wiki.
• OLPC Austria's Activity Handbook

Topic Ideas

• Setup a development environment. With and without jhbuild.
• "Write your activity" tutorial. It should include:
  • graphic controls,
  • datastore,
  • collaboration.

http://flossmanuals.net/about

Programing reference

DocumentationTeam/API_Documentation