Meego Wiki
Views

SDK/How to create foobar sample tutorial

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
'''Note: This page under construction'''
+
This tutorial is a very quickly created example with a suggested outline for content of other tutorials.
-
 
+
-
This tutorial is a very quickly created example with a suggested outline for tutorial content.
+
== Overview ==
== Overview ==
-
<ol>
+
 
-
<li>How to setup your development environment</li>
+
Clear problem statement:
-
<li>The libraries you will need to build foobar sample</li>
+
 
-
<li>more to come</li>
+
* What are you demonstrating?
-
</ol>
+
* Why would someone want to follow this tutorial?
 +
* What should the end result be?
== Pre-requisites ==  
== Pre-requisites ==  
-
TBD.
+
 
 +
What you need to know:
 +
 
 +
* Expected skill set: e.g. languages required
 +
* Level of difficulty
 +
* Other tutorials you should do first
 +
 
=== System Setup ===
=== System Setup ===
-
TBD
+
 
 +
The system you need:
 +
 
 +
* What hardware do you need?
 +
* What software needs to be installed?
 +
* How does the system need to be configured?
== How to ==
== How to ==
-
Here are some ideas to consider:
+
 
-
* Clear problem statement:  What are you demonstrating
+
How to achieve the goal:
-
* Solution
+
 
 +
* Solution in a nutshell
* Code
* Code
* Screenshots (if applicable)
* Screenshots (if applicable)
-
* Related articles
+
* Troubleshooting (what if something goes wrong)
-
* Troubleshooting
+
 
 +
== Related articles ==
 +
 
 +
Other tutorials to go on to

Revision as of 10:13, 13 December 2010

This tutorial is a very quickly created example with a suggested outline for content of other tutorials.

Contents

Overview

Clear problem statement:

  • What are you demonstrating?
  • Why would someone want to follow this tutorial?
  • What should the end result be?

Pre-requisites

What you need to know:

  • Expected skill set: e.g. languages required
  • Level of difficulty
  • Other tutorials you should do first

System Setup

The system you need:

  • What hardware do you need?
  • What software needs to be installed?
  • How does the system need to be configured?

How to

How to achieve the goal:

  • Solution in a nutshell
  • Code
  • Screenshots (if applicable)
  • Troubleshooting (what if something goes wrong)

Related articles

Other tutorials to go on to

Personal tools