Documentation Projects: Difference between revisions

From OLPC
Jump to navigation Jump to search
(→‎Activity Handbook: reorganize, make consistent with other docs, mention Sugar Almanac)
m ({{obsolete}} obsoletes {{merge}})
 
(32 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{obsolete |note=This is historical, see |link=[[Manuals]]}}
== What Exists ==
== What Exists ==
[[Manuals]] lists complete substantial manuals for the project.

There are many incomplete and somewhat obsolete manuals for the laptop:
There were other evolving, incomplete or somewhat obsolete manuals for the laptop:


=== Getting Started ===
=== Getting Started ===
Line 9: Line 10:
* ''Getting Started'' in HTML [http://www.laptop.org/en/laptop/start/]
* ''Getting Started'' in HTML [http://www.laptop.org/en/laptop/start/]
* ''Getting Started'' as a PDF [http://laptop.org/en/laptop/start/getting_started_3.pdf]
* ''Getting Started'' as a PDF [http://laptop.org/en/laptop/start/getting_started_3.pdf]
* ''Getting Started'' at the SugarLabs wiki [http://wiki.sugarlabs.org/go/Connecting_to_the_Internet]
* ''Getting Started'' at the Sugar Labs wiki [http://wiki.sugarlabs.org/go/Getting_Started]


=== FLOSS Manuals ===
=== 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
* 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
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 ===
Line 25: Line 32:


==== Assorted Offspring ====
==== Assorted Offspring ====
http://wiki.laptop.org/go/Support_FAQ/es<br>
* [[Support_FAQ/es]]
http://www.ee.ryerson.ca/~elf/olpc/XOSupportFAQ.pdf<br>
* http://www.ee.ryerson.ca/~elf/olpc/XOSupportFAQ.pdf<br>
http://wiki.laptop.org/go/Support_Gang/RTFM
* [[Support_Gang/RTFM]]


==== Competing FAQ's ====
==== Competing FAQ's ====
Line 39: Line 46:
* RTFM's from Support Gang (form letters / FAQ for email response)
* RTFM's from Support Gang (form letters / FAQ for email response)


⚫
=== Sugar Almanac ===
⚫
* [[Sugar Almanac]] is a detailed guide to the Sugar API for activity developers.

=== Make Your Own Sugar Activities! ===

By Jim Simmons:<br>
[http://objavi.flossmanuals.net/books/ActivitiesGuideSugar-en-2010.01.11-23.05.32.pdf JAN 12th 2010 DRAFT!]<br>
[http://objavi.flossmanuals.net/books/ActivitiesGuideSugar-en-2010.01.21-18.33.56.pdf JAN 21st 2010 DRAFT!]<br>
[http://objavi.flossmanuals.net/books/ActivitiesGuideSugar-en-2010.02.03-18.11.39.pdf FEB 3rd 2010 DRAFT!]<br>
[http://en.flossmanuals.net/ActivitiesGuideSugar/Introduction FEB 23rd 2010 near-final HTML]<br>
[http://objavi.flossmanuals.net/books/ActivitiesGuideSugar-en-2010.03.05-04.59.13.pdf MCH 4th 2010 FINAL?]


=== Activity Handbook ===
=== Activity Handbook ===
Line 44: Line 62:
: "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."
: "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 [http://www.olpcaustria.org/mediawiki/index.php/Introduction_to_Sugar Introduction to Sugar], a general introduction to the Sugar Learning Environment.
** Chapter One of Christoph's guide is [http://www.olpcaustria.org/mediawiki/index.php/Introduction_to_Sugar Introduction to Sugar], a general introduction to the Sugar Learning Environment.

⚫
=== Sugar Almanac ===
⚫
* [[Sugar Almanac]] is a detailed guide to the Sugar API for activity developers.


=== Deployment Guide ===
=== Deployment Guide ===
* [[Deployment Guide]]
* [[Deployment Guide]]



== Localized Documents ==
== Localized Documents ==
Line 59: Line 73:
'''Link Needed'''
'''Link Needed'''


=== Ciebal Manual / Guide (Uruguay) ===
=== Ceibal Manual / Guide (Uruguay) ===
* Uruguayan Guide (actual book!)
* Uruguayan Guide (actual book!)
* "Ceibal in the society of the 21st century" (Uruguay) goes well beyond just-a-manual:
* "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
http://olpc-ceibal.blogspot.com/2008/07/on-june-th-27th-we-launched-book-ceibal.html


=== Pashto & Dari Manual (2 official languages of Afghanistan) ===


* In PDF herein: [[OLPC Pakistan Activities]]


⚫
[[Category:Documentation]]
== Obsolete Manuals ==
=== Nortel LearnIT's ~B2 Manual ===
* Nortel LearnIT's [http://nortellearnit.org/LearniT/usingthexo How to Use Your XO Laptop]

=== XO Guide ===
* https://dev.laptop.org/~sj/.library_pages/xo-guide/bundle_index.html
:''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 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.

[[Category:Content]]
⚫
[[Category:Documentation]]
[[Category:Sugar]]

Latest revision as of 09:30, 30 January 2012

542-stopicon.png This is historical, see Manuals

What Exists

Manuals lists complete substantial manuals for the project. There were 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

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

Ceibal 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)

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