Documentation

OLPC hardware and software is designed to be discoverable so that a user can figure things out by experimentation. We are preparing teachers by extensively lecturing and writing about how the devices might be leveraged. The OLPC laptops will come with e-books documenting how to use them, and technical details needed by application developers are available on the web including this wiki.

Examples: see the user interface guidelines and a draft developers handbook.

There are many audiences for the laptops and their software and content; some of them may need to create their own instructional material, or their own versions of existing material. This wiki is open for development of such material. If you have created your own documentation -- for instance, text, screenshots, video or animation for the hardware or specific software that is being turned into an activity -- note it here.

TODO

We need to improve speed/accuracy of

() noting the need for pascals doc
() making sure it gets created
(*) integrating it with other such docs in a organizing framework
() having an organizing framework 
() keeping the docs up to date / tagged with freshness indicators

Needs

• Comments in code -- clean up, write for children, translate, in synthesis make the code "readable" and localizable.
• Notes about development -- how to create a 'hello world' activity or bundle. This is intented to be in Activity_Template and others.
• Community introduction -- getting to know and collab with the social community of developers and supporting groups
• Packaging/downloading guide -- how to package, where to publish, how to find and download.(stable and unstable documentation)
• Testing guide -- how to write test plans, who tests, how to help test, how to read the results of automated / human tests.
• Build/release guide -- how builds are made how often, where they end up; stable v unstable; how an activity gets into a buld, how to build a costomized build.
• Fix and organize different types and pages of documentation that are spread in the wiki.

Specific examples

Wikitexts

• General introduction and user interface guidelines
• Emulating the OLPC environment on another computer
• The Sugar Architecture
• xo "how to" notes

Images/Pictures

• (from christina xu... to find on Flickr)

Tutorials

• Forth Lessons

Videos

• Etoys tutorial
• User interface introduction
• social features introduction

This page needs clean-up and editing for coherence, clarity, and completeness.

Please improve this article if you can.