Manuals: Difference between revisions

From OLPC
Jump to navigation Jump to search
No edit summary
 
(114 intermediate revisions by 15 users not shown)
Line 1: Line 1:
'''The OLPC Manual is available as a [[Help_(activity)|Help Activity]] ([http://activities.sugarlabs.org/en-US/sugar/addon/4051 1], [[Activities/Help-G1G1|2]]) for XO-1 and XO-1.5, and also online at http://laptop.org/manual'''
<big>A manual for Group 1</big>: a '''[[Simplified users guide]]''' is being developed.
: A second manual for them : [http://nortellearnit.org/LearniT/usingthexo via Nortel LearniT]
: with videos...


== Mailing List ==
<big>A manual for Group 0</big>: including people who just want to know a bit more about the laptop, is available from [https://dev.laptop.org/~sj/.library_pages/xo-guide/bundle_index.html our demo library]. (to be wikified)


Discussions about the OLPC/Sugar Manuals take place on the Library Mailing list. If you would like to join the conversation, sign up: [http://lists.laptop.org/listinfo/library here].
== History ==
Some early discussion about a manual with Asher Heimermann were very useful. See also contributions by [[user:annegentle|Anne Gentle]], [[user:ToddKelsey|Todd Kelsey]] and [[user:mokurai|Ed Cherlin]] on this wiki.


=== Technical audiences ===
== Manuals ==
=== Emerging manuals ===
There are at least four technical audiences:


[http://wiki.sugarlabs.org/go/Documentation_Team/Notes/1.0 Sugar Labs effort organized by S. Daniel Francis]
'''Group 0''': '''All people''' who just want to know a bit more about the laptop


[http://laptop.org/start Getting Started (for recent 2010/2011 software especially!)] Interactive HTML guide overhauls the [http://laptop.org/7.1.0/start famous original from 2007/2008].
'''Group 1''': '''Kids/novices''' - tutorials, self-tour, etc.


[http://laptop.moodle.com.au/manual/ OLPC Australia Manual] <b>(NEW)</b>
'''Group 2''': '''Teachers/parents/adults'''/etc. (people developing/presenting
content, facilitating activities, etc.) There's a lot of crossover
between Group 1 and Group 2, especially in the beginning stages of the
program. - tutorials, activities, etc.


[[Media:One Laptop per Rwandese Child.pdf| One Laptop per Rwandese Child]] <b>(NEW 16-page PDF guide)</b>
'''Group 3''': '''1st-tier support''' (site experts, server/internet connection
maintainers, etc.) - people representing the site. There's a lot of
crossover between Group 2 and Group 3. - "training" program as part of
rollout; needs to define roles/responsibilities/expectations as well as
technical stuff.


Jim Simmons' [http://en.flossmanuals.net/ActivitiesGuideSugar/Introduction Make Your Own Sugar Activities!] <b>([http://objavi.flossmanuals.net/books/ActivitiesGuideSugar-en-2010.03.05-04.59.13.pdf PDF], [http://www.lulu.com/product/paperback/make-your-own-sugar-activities/12047878 $12 in book form] NEW)</b>
'''Group 4''': '''2nd-tier support''' (server installers, troubleshooters/fixers,
etc.) - people representing the organization(s) deploying the olpc
program - again, "training" program as part of the rollout. Similar
coverage of roles/responsibilities/expectations, though with a more
technical bent than the Group 3 stuff.


Check out our DRAFT [[ClassActs/Resources|"Class Acts"]] guide for community deployment resources.
There may be additional, more technical audiences (hackers, developers,
etc.); because of the self-supporting nature of the program, this group
would probably best be served by a wiki/listserve, etc.--open,
bidirectional communication.


OLPC Software Release [[11.3.1]] should be released well before our [http://j.mp/xomanual doc sprint expected Apr 6-10, 2012] in Cambridge, Massachusetts!
=== Startup sheets ===
A "startup sheet" for support and maintenance should probably cover a few basic things. Sheets for a few audiences; at least groups 2 (config and troubleshooting) and 3 (distributing) above.


=== Recent manuals ===
'''Basics'''
* Care and feeding of the laptop (don't leave it out in the rain, don't jump up and down on it, etc.)
* First-time use (hopefully OLPC has come up with a coherent out-of-box scenario)
* How to charge up the laptop, and how to know when it needs charging. (This could be a new concept for many people in your target audience)
* How laptops link to each other in a mesh, and how they link to a server for Internet access
* How to access a browser and type in a URL--such as the support URL for OLPC.


OLPC Australia published Lesson Ideas and Guides in May 2013: http://academy.one-education.org
What happens if the installer can't establish an Internet connection? How will that be handled?


OLPC Canada's 92-page [http://www.olpccanada.com/impact/ Educator's Guide] <b>(NEW, see bottom of their page)</b>. With lesson plans created by Canadian teachers that work in First Nations communities. OLPC Canada grants permission to remix/translate its lessons wherever it helps other countries.


The OLPC [http://laptop.org/manual Manual] is available in several formats:
== Other thoughts on writing and maintaining texts ==
* <b>The [[Help (activity)|Help Activity]] available ([http://activities.sugarlabs.org/en-US/sugar/addon/4051 updated by Gonzalo Odiard] in 2013!)</b>
We probably need to differentiate between technical and non-technical
* Online manual: http://laptop.org/manual (VERY DATED)
content, and figure out a way of categorizing the two. I don't think we
* [http://en.flossmanuals.net/publish/PDF/g1g1_2.pdf Downloadable PDF] (4.7MB, 254 pages) {this link doesn't work}
need to do a formal information taxonomy, but we should allow room for
** which is [http://www.lulu.com/content/4439260 purchasable in book form for $15]
something like that later.
* OLPC Australia: XO Comes to Class [[Image:XOComesToClassV1 1.pdf]] (7.4MB, 149 pages)


It was created by volunteers from a combination of two manuals for 8.2.0 developed at [[FLOSSManuals]]:
* Technical content: stuff related to olpc themselves, servers,
* http://en.flossmanuals.net/XO ([http://en.flossmanuals.net/XO/print single-page "print" version])
deployment, installation, maintenance, etc.
* http://en.flossmanuals.net/Sugar ([http://en.flossmanuals.net/Sugar/print single-page "print" version]


;[[Support FAQ]]
* Non-technical content: curriculum (lessons, activities, learning
:Frequently Asked Questions answered by OLPC's [[Support Gang|Community Support Volunteers!]]
materials, etc.)


;[[Deployment Guide]]
=== How does this scale? ===
:A generalized guide to a large-scale deployment of one laptop per child.
How many tiers of management/expertise/content development will be needed? This is something each "market" (education ministry, other) will be helping to define, but there probably should be some kind of management model in place to
help things along and provide some kind of "template" for deployment/technical management/content development, etc.


;[[Developers manual]]
=== Content management ===
Conveniently right here online on this wiki, overhauled in 2011 by [http://reactivated.net Daniel Drake] especially.
Three main use cases for distributed and interleavable content management for different audiences:


;[[Sdenka Salas - The XO Laptop in the Classroom]] (NEW from Peru, 5.5 MB / 102 pages; [http://wiki.sugarlabs.org/go/File:La_Laptop_XO_en_el_Aula.pdf in Spanish too!] 6.7MB / 106 pages, In French [http://olpc-france.org/docs/L_Ordinateur_XO_dans_la_classe_v1_0.pdf here] 15 MB / 102 pages and in Arabic thanks to Dr. Rashid Ismael [http://wiki.laptop.org/images/0/07/%D8%A7%D9%84%D9%83%D9%85%D8%A8%D9%8A%D9%88%D8%AA%D8%B1_%D8%A7%D9%84%D9%85%D8%AD%D9%85%D9%88%D9%84_%D8%A5%D9%83%D8%B3_%D8%A3%D9%88_%D9%81%D9%8A_%D8%A7%D9%84%D9%81%D8%B5.pdf]). The English version has an old image of Sugar.
1) documentation and tutorials [like what is discussed above]
:The lesson ideas in this book show many ways the XO and Sugar interface can be put to work in classrooms.
2) textbooks and learning materials [like what big textbook orgs use]
3) interactive applications and software [standard l10n]


;[http://www.flordeceibo.edu.uy/files/Manual-XO-2.2.pdf "Manual Basico XO" (2da edicion)] (2.5MB / 48 pages)
'''Language support''': Will users be able to go to a multi-lingual
:Uruguay's colorful starter guide!
portal and click on the language of their choice, or will each
language's support be defined on the startup sheet? (Or will this be
the default home page for the laptop's browser?)


[http://wiki.laptop.org/go/Manual/Insides Images of the inside of the Laptop], care of Ari.
;[http://wiki.laptop.org/go/Image:OLPC-XO_Manual.pdf NEW Spanish Starter Guide] (15MB / 31 pages)
:Colorful: get-to-know your XO Laptop and the Sugar Learning Platform.


;[[Activity Handbook]] (594KB / 59 pages)
== Mailing List ==
:A software developer's guide for creating software for [[Sugar]].
There is a mailing list with weekly manual/documentation updates (the olpc library mailing list): http://mailman.laptop.org/listinfo/library

;[http://sugarlabs.org/go/Development_Team/Almanac Sugar Almanac]
:A detailed guide for developers to the APIs in Sugar.

;[http://www.laptop.org/laptop Laptop overview]
: A short overview of the XO laptop's hardware and software features.

;[http://olpcnews.com/files/OLPC_Teacher_Guide.pdf Teacher's Guide to the XO and Deployment version 1.0]
: A guide for teacher's new to the XO with a suggested deployment model, lesson plans, teacher reflections and more as written for Australian teachers. Version 2.0 is currently in development.

===Manuals in Arabic===
[http://wiki.laptop.org/images/9/9c/OLPCXOManualArabic.pdf XO Starter Manual]

[http://wiki.laptop.org/images/9/9f/OLPC_Manual.pdf UNRWA Starter Manual]

[http://wiki.laptop.org/images/6/69/BrowseActivityManual.pdf PaleXO Browse Activity Manual]

[http://wiki.laptop.org/images/e/e2/ChatActivityManual.pdf PaleXO Chat Activity Manual]

[http://wiki.laptop.org/images/4/46/FixedWriteActivityManual.pdf PaleXO Write Activity Manual]

[http://translate.flossmanuals.net/XO_ar/Introduction Floss Manuals] [http://activities.sugarlabs.org/en-US/sugar/addon/4332 download Arabic Help activity] Translated by a volunteer from Morocco!

[http://wiki.laptop.org/images/3/39/Xo_guide-Arabic.pdf Second version of XO Arabic manual by UNRWA team]

[http://wiki.laptop.org/images/0/07/%D8%A7%D9%84%D9%83%D9%85%D8%A8%D9%8A%D9%88%D8%AA%D8%B1_%D8%A7%D9%84%D9%85%D8%AD%D9%85%D9%88%D9%84_%D8%A5%D9%83%D8%B3_%D8%A3%D9%88_%D9%81%D9%8A_%D8%A7%D9%84%D9%81%D8%B5.pdf Arabic version of Sdenka Salas - The XO Laptop in the Classroom, thanks to Dr. Rashid Ismael]

===Manuals in Spanish===

A growing list of [[Recursos_en_espanol|resources from deployments]] across Latin America.

=== Manuals for earlier releases ===
;[http://laptop.org/7.1.0/gettingstarted/ Getting Started] guide
:Beautiful, interactive pages that describe XO hardware and the [[Release notes/7.1.0|7.1.0]] or "ship.2" release.

;[http://en.flossmanuals.net/OLPC_simple OLPC/Sugar simple user's guide at Flossmanuals]
:This was the manual for the [[Release_notes/7.1.0|7.1.0]] or "ship.2" release (builds 650-653) that most [[G1G1 2007]] users received on their XO laptops.

=== Inactive manuals ===
;Nortel LearnIT [http://nortellearnit.org/LearniT/usingthexo Using the XO Laptop]
:Old and incomplete
;The OLPC Wiki's [[Simplified user guide]]
:''What is the Migration status and difference from FlossManuals?''
;[https://dev.laptop.org/~sj/.library_pages/xo-guide/bundle_index.html XO Guide]
:shows some interactive brief HTML pages about the XO software ''from 2007'' that would have been part of the OLPC [[Library]] home page for the Browse activity.

;[[Demo notes]] from 2007

==Other books==

Please also see our community's many other [[Books|ebooks, textbooks, picturebooks]], [[presentations]], and other [[:Category:Content|content]]!

The Sugar Labs wiki has a [http://wiki.sugarlabs.org/go/Getting_Started/Explore guide to exploring the Sugar UI].


[[Category:Documentation]]
(There is also an older mailing list at http://lists.cftwinc.com/mailman/listinfo/olpc-manual
which is being phased out but has relevant archives.)

Latest revision as of 22:50, 28 May 2013

The OLPC Manual is available as a Help Activity (1, 2) for XO-1 and XO-1.5, and also online at http://laptop.org/manual

Mailing List

Discussions about the OLPC/Sugar Manuals take place on the Library Mailing list. If you would like to join the conversation, sign up: here.

Manuals

Emerging manuals

Sugar Labs effort organized by S. Daniel Francis

Getting Started (for recent 2010/2011 software especially!) Interactive HTML guide overhauls the famous original from 2007/2008.

OLPC Australia Manual (NEW)

One Laptop per Rwandese Child (NEW 16-page PDF guide)

Jim Simmons' Make Your Own Sugar Activities! (PDF, $12 in book form NEW)

Check out our DRAFT "Class Acts" guide for community deployment resources.

OLPC Software Release 11.3.1 should be released well before our doc sprint expected Apr 6-10, 2012 in Cambridge, Massachusetts!

Recent manuals

OLPC Australia published Lesson Ideas and Guides in May 2013: http://academy.one-education.org

OLPC Canada's 92-page Educator's Guide (NEW, see bottom of their page). With lesson plans created by Canadian teachers that work in First Nations communities. OLPC Canada grants permission to remix/translate its lessons wherever it helps other countries.

The OLPC Manual is available in several formats:

It was created by volunteers from a combination of two manuals for 8.2.0 developed at FLOSSManuals:

Support FAQ
Frequently Asked Questions answered by OLPC's Community Support Volunteers!
Deployment Guide
A generalized guide to a large-scale deployment of one laptop per child.
Developers manual

Conveniently right here online on this wiki, overhauled in 2011 by Daniel Drake especially.

Sdenka Salas - The XO Laptop in the Classroom (NEW from Peru, 5.5 MB / 102 pages; in Spanish too! 6.7MB / 106 pages, In French here 15 MB / 102 pages and in Arabic thanks to Dr. Rashid Ismael [1]). The English version has an old image of Sugar.
The lesson ideas in this book show many ways the XO and Sugar interface can be put to work in classrooms.
"Manual Basico XO" (2da edicion) (2.5MB / 48 pages)
Uruguay's colorful starter guide!
NEW Spanish Starter Guide (15MB / 31 pages)
Colorful: get-to-know your XO Laptop and the Sugar Learning Platform.
Activity Handbook (594KB / 59 pages)
A software developer's guide for creating software for Sugar.
Sugar Almanac
A detailed guide for developers to the APIs in Sugar.
Laptop overview
A short overview of the XO laptop's hardware and software features.
Teacher's Guide to the XO and Deployment version 1.0
A guide for teacher's new to the XO with a suggested deployment model, lesson plans, teacher reflections and more as written for Australian teachers. Version 2.0 is currently in development.

Manuals in Arabic

XO Starter Manual

UNRWA Starter Manual

PaleXO Browse Activity Manual

PaleXO Chat Activity Manual

PaleXO Write Activity Manual

Floss Manuals download Arabic Help activity Translated by a volunteer from Morocco!

Second version of XO Arabic manual by UNRWA team

Arabic version of Sdenka Salas - The XO Laptop in the Classroom, thanks to Dr. Rashid Ismael

Manuals in Spanish

A growing list of resources from deployments across Latin America.

Manuals for earlier releases

Getting Started guide
Beautiful, interactive pages that describe XO hardware and the 7.1.0 or "ship.2" release.
OLPC/Sugar simple user's guide at Flossmanuals
This was the manual for the 7.1.0 or "ship.2" release (builds 650-653) that most G1G1 2007 users received on their XO laptops.

Inactive manuals

Nortel LearnIT Using the XO Laptop
Old and incomplete
The OLPC Wiki's Simplified user guide
What is the Migration status and difference from FlossManuals?
XO Guide
shows some interactive brief HTML pages about the XO software from 2007 that would have been part of the OLPC Library home page for the Browse activity.
Demo notes from 2007

Other books

Please also see our community's many other ebooks, textbooks, picturebooks, presentations, and other content!

The Sugar Labs wiki has a guide to exploring the Sugar UI.

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