Documentation Team: Difference between revisions

No edit summary
Line 4: Line 4:


Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.
Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.
== BookSprint August 2008 ==
== Sugar FLOSS manual ==
FLOSS Manuals held a BookSprint during the last week of August in Austin, TX; together, we wrote separate but combinable (remixable) manuals for Sugar, individual Sugar Activities and the hardware it may run on, such as the XO.  
FLOSS Manuals held a BookSprint during the last week of August 2008 in Austin, TX; together, we wrote separate but combinable (remixable) manuals for Sugar, individual Sugar Activities and the hardware it may run on, such as the XO.  


Please see the [http://flossmanuals.net/Sugar '''Sugar Manual'''].
Please see the [http://flossmanuals.net/Sugar '''Sugar Manual'''].


The manuals for a number of Sugar Activities are now published (including manuals for [http://en.flossmanuals.net/write_activity '''Write'''], [http://en.flossmanuals.net/terminal '''Terminal'''], [http://en.flossmanuals.net/chat '''Chat'''], [http://en.flossmanuals.net/browse '''Browse'''], [http://en.flossmanuals.net/record '''Record'''], and [http://en.flossmanuals.net/turtleart '''TurtleArt''']). Please help us improve these manuals by going to http://en.flossmanuals.net/write where the editable versions reside. Note that we are including tutorials and notes to parents and teachers as part of the documentation effort. Helping expanding these sections would be greatly appreciated.
The manuals for a number of Sugar Activities are now published (including manuals for [http://en.flossmanuals.net/write_activity '''Write'''], [http://en.flossmanuals.net/terminal '''Terminal'''], [http://en.flossmanuals.net/chat '''Chat'''], [http://en.flossmanuals.net/browse '''Browse'''], [http://en.flossmanuals.net/record '''Record'''], and [http://en.flossmanuals.net/turtleart '''TurtleArt''']).  
 
Please help us improve these manuals by going to http://en.flossmanuals.net/write where the editable versions reside. Note that we are including tutorials and notes to parents and teachers as part of the documentation effort. Helping expanding these sections would be greatly appreciated.


Those who participated include: Adam Hyde, Anne Gentle, David Farning, Mikus Grinbergs, Brian Jordan, Adam Holt, Janet Swisher, Morgan Collett, Yama Ploskonka, David Cramer, Emily Kaplan, Faisal Anwar, Christoph Derndorfer, Sandy Culver, Aaron Konstam, and the Sugar community.  
Those who participated include: Adam Hyde, Anne Gentle, David Farning, Mikus Grinbergs, Brian Jordan, Adam Holt, Janet Swisher, Morgan Collett, Yama Ploskonka, David Cramer, Emily Kaplan, Faisal Anwar, Christoph Derndorfer, Sandy Culver, Aaron Konstam, and the Sugar community.  


Many thanks also to www.motive.com, our hosts in Austin.
Many thanks also to www.motive.com, our hosts in Austin.
== User Manuals ==
We will be working with [http://flossmanuals.net/about FLOSS manuals] to create our end user documentation.  Their excellent getting started guide  is at [http://flossmanuals.net/OLPC_simple OLPC simple].  Repurposing the best from these [http://wiki.laptop.org/go/Documentation_Projects 20 pre-existing documents] will be key.  Works in progress are listed in the DocumentationTeam/KnowledgeBase .
Here are rough working outlines:
Sugar Manual
Connecting to the network
Installing and configuring
Personalizing Sugar
Updating the version
Installing New Activities
Interface
Neighborhood View
Group View
Home View
Activity View
Joining Activities
Switching Activities
Exiting Activities
Troubleshooting Sugar
XO Manual
Getting started with the XO
About computers
Opening the XO
Starting the XO
Keyboard Shortcuts
Conserving Disk Space
Maintenance
Backing Up
Caring for Your XO
Charging the Battery
Replacing the Battery
Screen
Safety
Repairing Your XO
Avoiding Loss of Your XO
Hardware Specifications
Getting Support


'''See also'''
'''See also'''
Line 136: Line 65:


[[Category:DocumentationTeam]]
[[Category:DocumentationTeam]]
[[Category:General public]]