Software Tutorial Template

From NUI Group Community Wiki

Jump to: navigation, search

Contents

Introduction:

This is a tutorial about how you should format tutorials on multi-touch software development. The basic idea behind this is that you should copy the wiki-code for this tutorial page and replace the content of each section with details for your tutorial.

For example, this section is the introduction section, which should be the section where you briefly introduce the material you're going to cover in your tutorial, including any required or assumed knowledge.In this example you can see that I've described the entire objective of this tutorial in the first paragraph - don't waffle, tell your readers what you're going to do in your tutorial and briefly how you're going to go about it. e.g. "In this tutorial we will be developing an application which does something in some language".

Feel free to format your tutorial page however you like, but you may find this template a good place to start. Simply click edit at the top of this page and copy all of the wiki code into your new tutorial page to give yourself a basic template.

Requirements:

  • Operating System e.g. Windows XP
  • Frameworks e.g. Microsoft.NET 3.0
  • IDEā€¦ (Download) e.g. Visual Studio 2008
  • Touchlib v1.0
  • Rutime 0.0 + (Download)
  • Service API (Download)

\* Included in Tutorial Files

Author Details

Don't forget to sign your name here using the -- ~~~~ wiki code, so that you can get the credit you quite rightly deserve! You might also want to write a very brief description of who you are and what you do, but keep it under 256 words.

-- Nade 23:11, 3 October 2008 (UTC)

Tip: If you see an IP address when you use the -- ~~~~ then you need to log-in again because you're currently editing the page as an unregistered user.

Tutorial:

This is where the main body of your tutorial should be placed. Ideally you should split the tutorial into small sections or steps, so that users can easily return to complete the tutorial at a later date. We also recommend that you use sub-headings so that your material is clearly presented, and be sure to include lots of screen-shots and videos!

To include images, you'll need to upload them first using the [image uploader], and then include them in your documents using: [[Image:Wiki.png|thumb|Caption text]]

Any source code should be placed in <source lang=actionscript3> type tags.

As an example, we've included some simple steps which explain what you should write under each heading on your tutorial.

Step 1: Introduction

This section is where you introduce your main tutorial.

Step 2: Requirements:

This section is where you specify all of the software requirements to run the code.

Step 3: Tutorial:

Here's where you place the main tutorial text. You should try, if possible, to arrange your tutorial in a series of easy to follow steps or tasks.

Step 4: Full Source Code

This is where you can post or link to a full source code listing (recommended if not too long).

Step 5: Files

This is where you attach your main applications files or post a link to them. Please ensure that any software you submit is well documented.

Video Demonstration (Optional)

At the end of the tutorial you might also want to include some additional videos or images relating to your tutorial. This is also a great way to demonstrate what the user will be able to achieve if they follow your instructions carefully. A great program for making such tutorials is CamStudio, which is freely available from camstudio.org. Also here you can find this program PDF Converter Mac can convert any PDF files on Mac.

Source Code (Optional)

This is where you paste any source code for your program. Try to post full methods where possible, so that users can easily follow your instruction. If your source-code is quite long then please upload it to a third party site and link to it or contact a nuigroup admin in the forums to have it uploaded separately onto the site.

Include source-code using <source lang=actionscript3></source> tags - where lang can also be set to: c, actionscript, actionscript3, c, cpp, cpp-qt, csharp, java,objc, python, sql, vb, vbnet, xml and many other languages to enable the appropriate syntax highlighting.

Method: showMessage() in source.cs

public void showMessage(){
  MessageBox.Show("Example Source-code!");
}

Related Files (Optional)

Here is where you should link to a compressed file containing your source code/application. It is also a good place to link to any required libraries or further tutorials.

Installation Instructions (Optional)

This is where you provide simple instructions on how to download, install and configure your sourcecode.

  1. Download the tutorial files and extract to your desktop.
  2. ....
  3. ....
  4. ....


Running Instructions (Optional)

Here's where you should provide simple instructions on how to run your software (if applicable).

  1. Download the tutorial files and extract to your desktop.
  2. Run Configapp.exe
  3. ....
  4. ....