SDK/How to create foobar sample tutorial

Revision as of 10:09, 13 December 2010 (view source) Elliot (Talk | contribs) ← Older edit		Latest revision as of 15:03, 6 January 2011 (view source) Elliot (Talk | contribs) m (moved SDK/Docs/1.1/How to create foobar sample tutorial to SDK/How to create foobar sample tutorial)
(3 intermediate revisions not shown)
Line 1:		Line 1:
-	'''Note: This page under construction'''	+	== Overview ==
-	This tutorial is a very quickly created example with a suggested outline for tutorial content.	+	Clear problem statement:
-	== Overview ==	+	* One line summary, e.g. "This tutorial is a very quickly created example with a suggested outline for content of other tutorials"
-	<ol>	+	* What the tutorial demonstrates
-	<li>How to setup your development environment</li>	+	* Why you should want to follow this tutorial
-	<li>The libraries you will need to build foobar sample</li>	+	* The end result you should expect
-	<li>more to come</li>	+
-	</ol>	+
	== 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:
		+
		+	* Required hardware
		+	* What software needs to be installed
		+	* How the system needs 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	+
-	* Code	+	* 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)		* Screenshots (if applicable)
-	* Related articles	+	* Troubleshooting (what to do if something goes wrong)
-	* Troubleshooting	+
		+	== Related articles ==
		+
		+	Other tutorials to go on to

---

Latest revision as of 15:03, 6 January 2011

Contents 1 Overview 2 Pre-requisites 2.1 System Setup 3 How to 4 Related articles

Overview

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

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:

• Required hardware
• What software needs to be installed
• How the system needs to be configured

How to

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)

Related articles

Other tutorials to go on to