2,751
edits
Changes
mLine 1:
Line 1: − + − − We will need to create documentation for our own work, and we should contribute to OLPC documentation. − We need to decide on document formats and tools. At some point we will create new formats, based on our research into new textbook capabilities given Sugar software.+ − Participants in documentation (SMEs, writers, editors, designers...) should list themselves on the [[DocumentationTeam/Contacts]] page.+ + − + + Line 30:
Line 30: − − == Community == − − * [[ReleaseTeam/Roadmap]] − * [[ReleaseTeam|Release process]] − * [[BugSquad/ContentToEdit/Triage|Bug triage]] − * Publish your activity. Maybe we need bits of infrastructure to make this easier, something like [https://addons.mozilla.org/ firefox addons] - proposal at [[Activity portal]]. But even just a wiki page could be start if we maintain it well. −
started cleaning up doc docs
<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}
<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}{{TeamHeader|DocumentationTeam}}</noinclude>
{{TeamHeader|DocumentationTeam}}</noinclude>
Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.
== User Manuals ==
We will be working with [http://flossmanuals.net/about FLOSS manuals] to create our end user documentation. Their excellent getting started guide is at [http://flossmanuals.net/OLPC_simple OLPC simple]. Works in progress are listed in the DocumentationTeam/KnowledgeBase .
See also [http://wiki.laptop.org/go/OLPC_Publications OLPC Publications] in the OLPC Wiki.
See also [http://wiki.laptop.org/go/OLPC_Publications OLPC Publications] in the OLPC Wiki.
== API documentation ==
== Programming References ==
* sugar-base and sugar-toolkit has API documentation in the code. What tool do we use to generate html? Where do we generate it and where we make it available? Do we need to build them to generate docs?
* sugar-base and sugar-toolkit has API documentation in the code. What tool do we use to generate html? Where do we generate it and where we make it available? Do we need to build them to generate docs?
* Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
* Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
* Etoys based activity tutorial?
* Etoys based activity tutorial?
[[Category:DocumentationTeam]]
[[Category:DocumentationTeam]]