SDK/How to create foobar sample tutorial

From MeeGo wiki

< SDK(Difference between revisions)

Latest revision as of 15:03, 6 January 2011

Clear problem statement:

One line summary, e.g. "This tutorial is a very quickly created example with a suggested outline for content of other tutorials"
What the tutorial demonstrates
Why you should want to follow this tutorial
The end result you should expect

What you need to know:

The system you need:

How to achieve the goal:

Solution in a nutshell
Explanation of how to set up the project (it should either stand alone, or be linked to other tutorials which explain prerequisite steps)
Code examples with explanations (include every change and explain why you made each change)
Screenshots (if applicable)
Troubleshooting (what to do if something goes wrong)

@@ Line 29: / Line 29: @@
 * Solution in a nutshell
-* Explanation of how to setup as a project (it should either stand alone, or be linked to other projects which explain prerequisite steps)
+* Explanation of how to set up the project (it should either stand alone, or be linked to other tutorials which explain prerequisite steps)
-* Code examples
+* Code examples with explanations (include every change and explain ''why'' you made ''each'' change)
 * Screenshots (if applicable)
 * Troubleshooting (what to do if something goes wrong)