Documentation Projects

From OLPC
Jump to navigation Jump to search

What Exists

There are many incomplete and somewhat obsolete manuals for the laptop:

  • Getting Started by Walter Bender

http://www.laptop.org/en/laptop/start/
http://laptop.org/en/laptop/start/getting_started_3.pdf

  • 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/OLPC_simple

  • 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

Started by Support Gang, enhanced by Kate from Yale, see 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

  • Sugar labs current repository for the Getting started guide by Walter

http://wiki.sugarlabs.org/go/Connecting_to_the_Internet

  • Christoph and OLPC Austria created documentation for activity developers

Activity Handbook

  • Peruvian Guide (actual book!)
  • 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

  • Competing FAQ's:

Uruguay FAQ, translated from ES to EN by NLee & CBigenho (.doc & .pdf)
http://wiki.laptop.org/go/Official_OLPC_FAQ
http://wiki.sugarlabs.org/go/Community/FAQ
http://laptopgiving.org/en/faq.php
http://laptop.org/faq.en_US.html
http://wiki.laptop.org/go/Ask_OLPC_a_Question
(TP's information@laptop.org & giving@laptop.org form letters / FAQ)

  • OTHERS!

What is happening

  • Sugar Labs is working on creating documentation for Sugar. They are working with the current FLOSS manuals documentation team and are planning a content sprint in late August.
  • 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.

Documentation in Upcoming Builds

8.1.2

The current build is 8.1.1 (probably 708 still being tested). The next release in the current stream is 8.1.2 (711). 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.2.2

The next release after that is 8.2.0. That is going to be based on the joyride UI. Also Fedora is rebased from Fedora 7 to Fedora 9. This will contain a on first boot help activity. The plan is for OLPC and Sugar Labs to work together on this documentation.