BriefTutorialOutline

Brief Tutorial Outline

If you have an idea for a tutorial but do not want to write the whole thing, you can use this format to provide the docs and web team with all of the information they need to finish the tutorial. The most important parts are:

  • Description of the technology you're illustrating
  • Steps to reproduce
  • Beginning project if necessary
  • The finished product
  • The expected result when you run/deploy the project

Introduction


Use this section to provide a brief summary of the technology you're introducing. Focus on why a user would want to use this technology and provide examples of real-world use cases for the technology. If NetBeans has some special features that make using this technology easy, you might want to describe what they are.

Steps to Reproduce


This is one of the most crucial parts. You don't have to give the steps in too small of detail. For example, if you need to create a project, you don't have to list "Choose File > New Project..." We will fill those steps in as necessary. The important thing is listing all of the steps necessary and listing any code that the user has to fill in.

Beginning Project


It's nice to provide a pre-created project that already contains some of the basic code for the example. Attach the zipped up project to the wiki page for your tutorial. Remember to clean your project and remove the private directory before you zip it up. Also, if you have multiple projects that rely on each other, define the paths to those projects with relative links in project.properties instead of private.properties.

Solution


This is the most crucial part. Many people will just open the finished solution right away and poke around in the code. Lots of people will be looking at your code, so make sure that it's something Sun can be proud of (no bad coding practices, proper Javadoc comments explaining what's happening in the code, etc.)

Expected Result


List what the user should see when they run/deploy the project. Also list any troubleshooting information to resolve common problems.

Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo