(Created page with "'''Note: This page under construction''' This tutorial is a very quickly created example with a suggested outline for tutorial content. == Steps == <ol> <li>How to setup your …") |
m (moved SDK/Docs/1.1/How to create foobar sample tutorial to SDK/How to create foobar sample tutorial) |
||
| (7 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | + | == 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 == | == 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 | ||
Contents |
Clear problem statement:
What you need to know:
The system you need:
How to achieve the goal:
Other tutorials to go on to