View Single Post
qgil's Avatar
Posts: 3,105 | Thanked: 11,088 times | Joined on Jul 2007 @ Mountain View (CA, USA)
#13
Another element to consider is how a wiki page is organized.

For instance, a page like Native/Connectivity/Bluetooth:

- Intro: overview of the features available and the main aspects to consider.

- Link to the full API docs, that should be well documented enough in themselves.

- Few basic examples (few lines of code) for the most usual cases + link to more and more complex examples available in maemo.gitorious.org and even real exemplar OSS projects.

- Tips & Tricks: since this is a wiki real developers could add here their questions, posting the answers themselves or waiting to someone to answer. The input here would help having better API docs, better code examples and better tutorials. Very useful specially in the Alpha/Beta times, when a lot of new questions arise.

- Links to further information e.g. tutorials, generic Qt docs/examples, related platform docs, useful upstream docs...