Difference between revisions of "Documentation Team/Getting Involved"

From Sugar Labs
Jump to: navigation, search
m (first iteration through docteam cleanup)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}{{TeamHeader|DocumentationTeam}}</noinclude>
+
<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}{{TeamHeader|Documentation Team}}</noinclude>
 +
{{TOCright}}
 +
==Users Manual==
 +
Please see [[Documentation Team/Book Sprint| Book Sprint]] for information on a up comming book sprint.
 +
 
 +
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 [http://flossmanuals.net/about 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 [http://en.flossmanuals.net/write community] rather then contribute directly to Sugar Labs user documentation. 
 +
 
 +
Their excellent getting started guide is at [http://flossmanuals.net/OLPC_simple OLPC simple]. 
 +
 
 +
Works in progress are listed in the Documentation Team/KnowledgeBase .
 +
 
 +
====Work In Progress, WIP====
 +
Currently, there are various 'works in progress' that we would like to combine into the definitive guide.
 +
 
 +
* [[Getting Started]]
 +
* [[User:Walter/sandbox/Home]]
 +
* [[Documentation Team/User_Manual]]
 +
* [[OLPC:OLPC_Publications OLPC Publications]] in the OLPC Wiki.
 +
* OLPC Austria's [http://www.olpcaustria.org/mediawiki/index.php/Activity_handbook Activity Handbook]
  
==Users Manual==
+
Topic Ideas
We always use help improving our User Manuals.  
+
* Setup a development environment.  With and without jhbuild.
 +
* "Write your activity" tutorial.  It should include:
 +
** graphic controls,
 +
** datastore,
 +
** collaboration.
  
 
http://flossmanuals.net/about
 
http://flossmanuals.net/about
  
 
==Programing reference==
 
==Programing reference==
[DocumentationTeam/API_Documentation]
+
[[Documentation Team/API_Documentation]]
  
 
==Tutorials==
 
==Tutorials==
  
[[Category:DocumentationTeam]]
+
[[Category:Documentation Team]]
 +
[[Category:Participate]]

Latest revision as of 20:15, 24 February 2010

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

Users Manual

Please see Book Sprint for information on a up comming book sprint.

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 Documentation Team/KnowledgeBase .

Work In Progress, WIP

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

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

Documentation Team/API_Documentation

Tutorials