Documentation Projects

From OLPC
Revision as of 20:13, 21 November 2011 by Patrol (talk | contribs) (Reverted edits by 109.99.78.158 (Talk) to last revision by FGrose)
Jump to navigation Jump to search
Merge-arrows.gif
It has been suggested that this article or section be merged with Manuals. (Discuss)

What Exists

Manuals lists complete substantial manuals for the project. There are other evolving, incomplete or somewhat obsolete manuals for the laptop:

Getting Started

Getting Started was a project started at OLPC by Walter Bender. It has gone through multiple versions, been fractured, re-assembled, translated and distributed a number of times.

  • Getting Started as a Word document [1]
  • Getting Started in HTML [2]
  • Getting Started as a PDF [3]
  • Getting Started at the Sugar Labs wiki [4]

FLOSS Manuals

  • FLOSS Manuals started in Word, moved to Google Docs, moved to Author-it, moved to wiki.laptop.org. Writing by college students, Todd Kelsey, Emily Kaplan, Anne Gentle, Adam Hyde, with much editing work from Kelly Holcomb; time-intense translation support on the wiki.laptop.org copies by Micheal Cooper

http://en.flossmanuals.net/XO http://en.flossmanuals.net/Sugar_guide


Much of the work on the current set of manuals was done at the Austin Book Sprint Aug 24-29, 2008.

http://sugarlabs.org/go/Documentation_Team

Simplified User Guide

  • Simplified user guide same starting story as the FLOSS Manuals version, but an earlier version of the content at FLOSS manuals, with intentions of synching the two by using Floss Manual's API for inclusion of Floss version on the wiki.laptop.org page

Support FAQ

Started by Support Gang, enhanced by Kate from Yale, see offspring:

Assorted Offspring

http://wiki.laptop.org/go/Support_FAQ/es
http://www.ee.ryerson.ca/~elf/olpc/XOSupportFAQ.pdf
http://wiki.laptop.org/go/Support_Gang/RTFM

Competing FAQ's

Sugar Almanac

  • Sugar Almanac is a detailed guide to the Sugar API for activity developers.

Make Your Own Sugar Activities!

By Jim Simmons:
JAN 12th 2010 DRAFT!
JAN 21st 2010 DRAFT!
FEB 3rd 2010 DRAFT!
FEB 23rd 2010 near-final HTML
MCH 4th 2010 FINAL?

Activity Handbook

  • Activity Handbook is documentation for activity developers by Christoph and OLPC Austria.
"The purpose of the activity handbook is to provide you with all the information you need in order to get started with software development for the OLPC XO."
    • Chapter One of Christoph's guide is Introduction to Sugar, a general introduction to the Sugar Learning Environment.

Deployment Guide

Localized Documents

These are documentation projects that were originated in

Peruvian Guide

  • Peruvian Guide (actual book!)

Link Needed

Ciebal Manual / Guide (Uruguay)

  • Uruguayan Guide (actual book!)
  • "Ceibal in the society of the 21st century" (Uruguay) goes well beyond just-a-manual:

http://olpc-ceibal.blogspot.com/2008/07/on-june-th-27th-we-launched-book-ceibal.html

Pashto & Dari Manual (2 official languages of Afghanistan)

Obsolete Manuals

Nortel LearnIT's ~B2 Manual

XO Guide

History? If you know more about this please fill out this section

Demo Notes

Demo notes

Please fill in this section if you know about the Demo notes documentation

What is happening

  • Sugar Labs is working on creating documentation for Sugar. They are working with the current FLOSS manuals documentation team.
  • OLPC is interested in providing a first boot introduction documentation for XO users. With the upcoming G1G1 specifically in mind. This is being worked on by Seth on the OLPC side. There is a help activity by Marcos which uses HulaHop to display help content written in html.
  • There has also been talk on the OLPC side about implementing a help feature for activities. A help.html file would be required for activities.

Past Releases

8.1.x

8.1.2 build 711 was released 2008-08-19. This will likely contain an activity that is a repackaging of the getting started guide. It won't run on first boot, and in worst case scenario will get shipped with G1G1. 8.1.3 Build 714 was never released - pushed back to 8.2.0.


8.2.0

The current build is 8.2.0 Build 767 which was released 2008-10-14. That will use the revised Sugar UI that has been developed in joyride builds (Release_Notes/8.2.0 outlines the UI changes). Also Fedora is rebased from Fedora 7 to Fedora 9. This will contain an on first boot help activity. The plan is for OLPC and Sugar Labs to work together on this documentation.

See Release_notes

Documentation in Upcoming Releases

8.4.0

Set to release in March 2009, documentation for this release should update the manuals with the 8.2.0 set as a starting point.

http://en.flossmanuals.net/XO http://en.flossmanuals.net/Sugar_guide

These manuals should also be published to HTML so that they can be deployed in the Help Activity.

Screenshots should be updated as well, so if you take new screenshots do name them with an 8.4 convention.

See Future_releases

Retrieved from "http://wiki.laptop.org/mediawiki/index.php?title=Documentation_Projects&oldid=263062"