excellent idea!<br><br>try to allow the examples to come from different toolkits.<br>there is more than one method of doing everything.<br>if the same question is answered in both gtk and qt for instance, <br>it will help existing developers to adapt and see the differences in approaching problems.<br>
<br>gary<br><br><br><div class="gmail_quote">On Thu, Feb 11, 2010 at 11:44 PM, Dave Neary <span dir="ltr"><<a href="mailto:dneary@maemo.org">dneary@maemo.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
Hi everyone,<br>
<br>
Titta from Lionbridge has been working hard in recent months to<br>
understand what is needed to make Maemo's developer documentation rock,<br>
and one of her key goals is to ensure that the Maemo community is<br>
involved in the creation of documentation - but setting priorities and<br>
helping write and improve documentation.<br>
<br>
Her group has just created a "Use-case template" in the wiki:<br>
<a href="http://wiki.maemo.org/Documentation/Use_case_template" target="_blank">http://wiki.maemo.org/Documentation/Use_case_template</a><br>
<br>
The idea of a Use-case, as Titta has explained it to me, is that this<br>
will be a very focussed document which will explain how to solve a<br>
particular problem with the Maemo platform. It's not API documentation,<br>
nor is it an overall guide of the platform, it's a stand-alone piece of<br>
documentation that helps a developer perform a frequently requested task.<br>
<br>
Some examples that came to mind when we were talking about this were:<br>
<br>
* How can I get & use accelerometer data on the N900?<br>
* How can I get a list of media files on the device?<br>
* How can I create a new sharing plug-in for my favourite online service?<br>
* How should I store & retrieve configuration for my application?<br>
<br>
Some of these may be API-specific (like the last one & gconf), but the<br>
API is the question, not the answer. The general principle is: make sure<br>
that the question you want answered is a well defined problem that a<br>
developer might have, and doesn't make any assumptions about the<br>
platfoiorm (that's what the answer's for).<br>
<br>
So what's next? We want to gather suggestions for use-cases that need<br>
documenting, then we'll create a wiki page for each one, then we (and by<br>
we, I mean "the Maemo Community" will answer the questions. The answers<br>
will include code snippets, and brief introductions to the purpose of<br>
any libraries we use. The end result should be a library of code<br>
snippets that could potentially become a Maemo cookbook.<br>
<br>
So - the floor is open! Don't all shout at once. What stuff would you<br>
like to know? Or, having run the gauntlet & solved a problem in the<br>
past, which things do you think should be more clearly documented &<br>
explained? Want to help document your struggles?<br>
<br>
Thanks for all your help!<br>
<br>
Cheers,<br>
Dave.<br>
<br>
--<br>
<a href="http://maemo.org" target="_blank">maemo.org</a> docsmaster<br>
Email: <a href="mailto:dneary@maemo.org">dneary@maemo.org</a><br>
Jabber: <a href="mailto:bolsh@jabber.org">bolsh@jabber.org</a><br>
<br>
_______________________________________________<br>
maemo-developers mailing list<br>
<a href="mailto:maemo-developers@maemo.org">maemo-developers@maemo.org</a><br>
<a href="https://lists.maemo.org/mailman/listinfo/maemo-developers" target="_blank">https://lists.maemo.org/mailman/listinfo/maemo-developers</a><br>
</blockquote></div><br>