m (moved SDK/Docs/1.1/How to create foobar sample tutorial to SDK/How to create foobar sample tutorial) |
|||
| (2 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | |||
| - | |||
== Overview == | == Overview == | ||
Clear problem statement: | Clear problem statement: | ||
| - | * What | + | * One line summary, e.g. "This tutorial is a very quickly created example with a suggested outline for content of other tutorials" |
| - | * Why | + | * What the tutorial demonstrates |
| - | * | + | * Why you should want to follow this tutorial |
| + | * The end result you should expect | ||
== Pre-requisites == | == Pre-requisites == | ||
| Line 21: | Line 20: | ||
The system you need: | The system you need: | ||
| - | * | + | * Required hardware |
| - | * What software needs to be installed | + | * What software needs to be installed |
| - | * How | + | * How the system needs to be configured |
== How to == | == How to == | ||
| Line 30: | Line 29: | ||
* Solution in a nutshell | * Solution in a nutshell | ||
| - | * Code | + | * 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) | ||
| - | * Troubleshooting (what if something goes wrong) | + | * Troubleshooting (what to do if something goes wrong) |
== Related articles == | == Related articles == | ||
Other tutorials to go on to | Other tutorials to go on to | ||
Contents |
Clear problem statement:
What you need to know:
The system you need:
How to achieve the goal:
Other tutorials to go on to